@atomic.io/action-cards-web-sdk-cdn-icons 24.3.0 → 24.3.2
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 +17 -13
- package/package.json +1 -1
- package/public/LICENSES.txt +25 -7
- package/public/iframe-manager.js +3 -3
- package/public/sdk.d.ts +2 -0
- package/public/sdk.js +3 -3
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
[](https://codecov.io/github/atomic-app/action-cards-web-sdk)
|
|
2
2
|
|
|
3
|
-
# Web SDK - Current (24.3.
|
|
3
|
+
# Web SDK - Current (24.3.2)
|
|
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 **24.3.
|
|
9
|
+
The current stable release is **24.3.2**.
|
|
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 `24.3.
|
|
21
|
+
The current version of the Atomic Web SDK is `24.3.2`, and is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/24.3.2/sdk.js`.
|
|
22
22
|
|
|
23
23
|
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.
|
|
24
|
-
This variant is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/24.3.
|
|
24
|
+
This variant is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/24.3.2/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/24.3.
|
|
32
|
+
<script src="https://downloads.atomic.io/web-sdk/release/24.3.2/sdk.js"></script>
|
|
33
33
|
</body>
|
|
34
34
|
</html>
|
|
35
35
|
```
|
|
@@ -271,6 +271,8 @@ You can customize the following strings used by the Web SDK, using the `customSt
|
|
|
271
271
|
- The title of the button allowing the user to retry the failed request for the card list or theme (`tryAgainTitle`).
|
|
272
272
|
- The text displayed on the card overlay while a file upload is in progress (`processingStateMessage`).
|
|
273
273
|
- The title of the button on the card overlay allowing the user to cancel file uploads that are currently in progress (`processingStateCancelButtonTitle`).
|
|
274
|
+
- The action text for a thumbnail image link (`thumbnailImageActionLinkTitle`).
|
|
275
|
+
- The action text for a thumbnail video link (`thumbnailVideoActionLinkTitle`).
|
|
274
276
|
|
|
275
277
|
If you don't provide these custom strings, the SDK defaults will be used:
|
|
276
278
|
|
|
@@ -286,6 +288,8 @@ If you don't provide these custom strings, the SDK defaults will be used:
|
|
|
286
288
|
- `tryAgainTitle`: "Try again"
|
|
287
289
|
- `processingStateMessage`: "Sending, please wait..."
|
|
288
290
|
- `processingStateCancelButtonTitle`: "Cancel process"
|
|
291
|
+
- `thumbnailImageActionLinkTitle`: "View"
|
|
292
|
+
- `thumbnailVideoActionLinkTitle`: "Watch"
|
|
289
293
|
|
|
290
294
|
The code snippet below shows how to customize some of these strings.
|
|
291
295
|
|
|
@@ -386,7 +390,7 @@ The code sample below shows how to use the `AtomicSDK.launch(config)` method, to
|
|
|
386
390
|
...
|
|
387
391
|
<body>
|
|
388
392
|
<!-- Installation -->
|
|
389
|
-
<script src="https://downloads.atomic.io/web-sdk/release/24.3.
|
|
393
|
+
<script src="https://downloads.atomic.io/web-sdk/release/24.3.2/sdk.js"></script>
|
|
390
394
|
|
|
391
395
|
<script>
|
|
392
396
|
AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
|
|
@@ -461,7 +465,7 @@ The iframe generated by the `singleCard` method can be styled just like any othe
|
|
|
461
465
|
...
|
|
462
466
|
<body>
|
|
463
467
|
<!--Installation-->
|
|
464
|
-
<script src="https://downloads.atomic.io/web-sdk/release/24.3.
|
|
468
|
+
<script src="https://downloads.atomic.io/web-sdk/release/24.3.2/sdk.js"></script>
|
|
465
469
|
|
|
466
470
|
<script>
|
|
467
471
|
AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
|
|
@@ -494,7 +498,7 @@ The iframe generated by the `embed` method can be styled just like any other DOM
|
|
|
494
498
|
...
|
|
495
499
|
<body>
|
|
496
500
|
<!--Installation-->
|
|
497
|
-
<script src="https://downloads.atomic.io/web-sdk/release/24.3.
|
|
501
|
+
<script src="https://downloads.atomic.io/web-sdk/release/24.3.2/sdk.js"></script>
|
|
498
502
|
|
|
499
503
|
<script>
|
|
500
504
|
AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
|
|
@@ -1830,10 +1834,10 @@ To use the SDK with your Cordova or Capacitor app:
|
|
|
1830
1834
|
|
|
1831
1835
|
1. Download the Atomic SDK from our CDN, and bundle it with your application. There are two files you need to download:
|
|
1832
1836
|
|
|
1833
|
-
- `https://downloads.atomic.io/web-sdk/release/24.3.
|
|
1834
|
-
- `https://downloads.atomic.io/web-sdk/release/24.3.
|
|
1837
|
+
- `https://downloads.atomic.io/web-sdk/release/24.3.2/iframe-manager.js`
|
|
1838
|
+
- `https://downloads.atomic.io/web-sdk/release/24.3.2/sdk.js`
|
|
1835
1839
|
|
|
1836
|
-
_Where `24.3.
|
|
1840
|
+
_Where `24.3.2` is the version number of the SDK you wish to use._
|
|
1837
1841
|
|
|
1838
1842
|
2. **(Cordova only)**: Modify the `Content-Security-Policy` meta tag in your Cordova app to allow the following URLs, after the `default-src` directive:
|
|
1839
1843
|
|
|
@@ -1896,7 +1900,7 @@ The level parameter is a number that indicates the verbosity of the logs exposed
|
|
|
1896
1900
|
The SDK allows you to set a callback via the `AtomicSDK.onError` property. This passes javascript errors that may occur in the SDK.
|
|
1897
1901
|
|
|
1898
1902
|
```js
|
|
1899
|
-
AtomicSDK.onError = function
|
|
1903
|
+
AtomicSDK.onError = function(error) {
|
|
1900
1904
|
// handle the reported error as required
|
|
1901
1905
|
console.error('An error occured in the Atomic SDK: ', error)
|
|
1902
1906
|
}
|
|
@@ -1920,7 +1924,7 @@ AtomicSDK.setClientAppVersion('Version 2.3.1')
|
|
|
1920
1924
|
|
|
1921
1925
|
## Third-party dependencies
|
|
1922
1926
|
|
|
1923
|
-
The Atomic Web SDK (as at the current release `24.3.
|
|
1927
|
+
The Atomic Web SDK (as at the current release `24.3.2`) uses the following third-party dependencies:
|
|
1924
1928
|
|
|
1925
1929
|
- Font Awesome Free `5.13.1`
|
|
1926
1930
|
- snarkdown `1.2.1`
|
package/package.json
CHANGED
package/public/LICENSES.txt
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
The Atomic Web SDK (24.3.
|
|
1
|
+
The Atomic Web SDK (24.3.2) uses the following open sources libraries:
|
|
2
2
|
|
|
3
3
|
-----------------------
|
|
4
4
|
|
|
@@ -90,11 +90,20 @@ MIT License
|
|
|
90
90
|
|
|
91
91
|
Copyright (c) <year> <copyright holders>
|
|
92
92
|
|
|
93
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
|
93
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
|
94
|
+
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
|
95
|
+
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
96
|
+
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
|
97
|
+
following conditions:
|
|
94
98
|
|
|
95
|
-
The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
99
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
100
|
+
portions of the Software.
|
|
96
101
|
|
|
97
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
|
102
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
|
103
|
+
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
|
104
|
+
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
105
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
|
106
|
+
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
98
107
|
|
|
99
108
|
|
|
100
109
|
-----------------------
|
|
@@ -136,11 +145,20 @@ MIT License
|
|
|
136
145
|
|
|
137
146
|
Copyright (c) <year> <copyright holders>
|
|
138
147
|
|
|
139
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
|
148
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
|
149
|
+
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
|
150
|
+
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
151
|
+
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
|
152
|
+
following conditions:
|
|
140
153
|
|
|
141
|
-
The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
154
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
155
|
+
portions of the Software.
|
|
142
156
|
|
|
143
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
|
157
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
|
158
|
+
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
|
159
|
+
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
160
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
|
161
|
+
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
144
162
|
|
|
145
163
|
|
|
146
164
|
-----------------------
|