@atomic.io/action-cards-web-sdk-cdn-icons 24.3.2 → 24.3.4
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 +13 -13
- package/package.json +1 -1
- package/public/LICENSES.txt +19 -19
- package/public/iframe-manager.js +3 -3
- 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 (
|
|
3
|
+
# Web SDK - Current (25.1.1)
|
|
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 **
|
|
9
|
+
The current stable release is **25.1.1**.
|
|
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 `
|
|
21
|
+
The current version of the Atomic Web SDK is `25.1.1`, and is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.1.1/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
|
+
This variant is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.1.1/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/
|
|
32
|
+
<script src="https://downloads.atomic.io/web-sdk/release/25.1.1/sdk.js"></script>
|
|
33
33
|
</body>
|
|
34
34
|
</html>
|
|
35
35
|
```
|
|
@@ -390,7 +390,7 @@ The code sample below shows how to use the `AtomicSDK.launch(config)` method, to
|
|
|
390
390
|
...
|
|
391
391
|
<body>
|
|
392
392
|
<!-- Installation -->
|
|
393
|
-
<script src="https://downloads.atomic.io/web-sdk/release/
|
|
393
|
+
<script src="https://downloads.atomic.io/web-sdk/release/25.1.1/sdk.js"></script>
|
|
394
394
|
|
|
395
395
|
<script>
|
|
396
396
|
AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
|
|
@@ -465,7 +465,7 @@ The iframe generated by the `singleCard` method can be styled just like any othe
|
|
|
465
465
|
...
|
|
466
466
|
<body>
|
|
467
467
|
<!--Installation-->
|
|
468
|
-
<script src="https://downloads.atomic.io/web-sdk/release/
|
|
468
|
+
<script src="https://downloads.atomic.io/web-sdk/release/25.1.1/sdk.js"></script>
|
|
469
469
|
|
|
470
470
|
<script>
|
|
471
471
|
AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
|
|
@@ -498,7 +498,7 @@ The iframe generated by the `embed` method can be styled just like any other DOM
|
|
|
498
498
|
...
|
|
499
499
|
<body>
|
|
500
500
|
<!--Installation-->
|
|
501
|
-
<script src="https://downloads.atomic.io/web-sdk/release/
|
|
501
|
+
<script src="https://downloads.atomic.io/web-sdk/release/25.1.1/sdk.js"></script>
|
|
502
502
|
|
|
503
503
|
<script>
|
|
504
504
|
AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
|
|
@@ -1834,10 +1834,10 @@ To use the SDK with your Cordova or Capacitor app:
|
|
|
1834
1834
|
|
|
1835
1835
|
1. Download the Atomic SDK from our CDN, and bundle it with your application. There are two files you need to download:
|
|
1836
1836
|
|
|
1837
|
-
- `https://downloads.atomic.io/web-sdk/release/
|
|
1838
|
-
- `https://downloads.atomic.io/web-sdk/release/
|
|
1837
|
+
- `https://downloads.atomic.io/web-sdk/release/25.1.1/iframe-manager.js`
|
|
1838
|
+
- `https://downloads.atomic.io/web-sdk/release/25.1.1/sdk.js`
|
|
1839
1839
|
|
|
1840
|
-
_Where `
|
|
1840
|
+
_Where `25.1.1` is the version number of the SDK you wish to use._
|
|
1841
1841
|
|
|
1842
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:
|
|
1843
1843
|
|
|
@@ -1900,7 +1900,7 @@ The level parameter is a number that indicates the verbosity of the logs exposed
|
|
|
1900
1900
|
The SDK allows you to set a callback via the `AtomicSDK.onError` property. This passes javascript errors that may occur in the SDK.
|
|
1901
1901
|
|
|
1902
1902
|
```js
|
|
1903
|
-
AtomicSDK.onError = function(error) {
|
|
1903
|
+
AtomicSDK.onError = function (error) {
|
|
1904
1904
|
// handle the reported error as required
|
|
1905
1905
|
console.error('An error occured in the Atomic SDK: ', error)
|
|
1906
1906
|
}
|
|
@@ -1924,7 +1924,7 @@ AtomicSDK.setClientAppVersion('Version 2.3.1')
|
|
|
1924
1924
|
|
|
1925
1925
|
## Third-party dependencies
|
|
1926
1926
|
|
|
1927
|
-
The Atomic Web SDK (as at the current release `
|
|
1927
|
+
The Atomic Web SDK (as at the current release `25.1.1`) uses the following third-party dependencies:
|
|
1928
1928
|
|
|
1929
1929
|
- Font Awesome Free `5.13.1`
|
|
1930
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.4) uses the following open sources libraries:
|
|
2
2
|
|
|
3
3
|
-----------------------
|
|
4
4
|
|
|
@@ -90,19 +90,19 @@ 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
|
|
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
|
|
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
97
|
following conditions:
|
|
98
98
|
|
|
99
|
-
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
100
|
portions of the Software.
|
|
101
101
|
|
|
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
|
|
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
106
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
107
107
|
|
|
108
108
|
|
|
@@ -145,19 +145,19 @@ MIT License
|
|
|
145
145
|
|
|
146
146
|
Copyright (c) <year> <copyright holders>
|
|
147
147
|
|
|
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
|
|
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
152
|
following conditions:
|
|
153
153
|
|
|
154
|
-
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
155
|
portions of the Software.
|
|
156
156
|
|
|
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
|
|
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
161
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
162
162
|
|
|
163
163
|
|