@wannaby/wanna-sdk 2.7.2 → 2.7.3-alpha.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 +9 -98
- package/core.js +1017 -1203
- package/iframe.html +1 -1
- package/package.json +1 -1
- package/sdk/NOTICE.txt +36 -121
- package/sdk/sdk.js +210 -486
package/README.md
CHANGED
|
@@ -1,107 +1,18 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
WANNA SDK enhances your website with virtual try-on experience for footwear and watches, which works directly in a mobile web browser without installing any apps. See the detailed documentation at the [WANNA website](https://docs.wanna.fashion/web/vto/getstarted).
|
|
4
|
-
|
|
5
|
-
<!-- TOC -->
|
|
6
|
-
- [License](#license)
|
|
7
|
-
- [Trial version limitations](#trial-version-limitations)
|
|
8
|
-
- [Install the library](#install-the-library)
|
|
9
|
-
- [API Reference](#api-reference)
|
|
10
|
-
- [Requirements and limitations](#requirements-and-limitations)
|
|
11
|
-
<!-- /TOC -->
|
|
1
|
+
WANNA SDK enhances your website with virtual try-on experience for footwear and watches, which works directly in a mobile web browser without installing any apps.
|
|
2
|
+
See the detailed documentation at the [WANNA website](https://docs.wanna.fashion/web/vto/getstarted).
|
|
12
3
|
|
|
13
4
|
## License
|
|
14
5
|
|
|
15
6
|
WANNA SDK is intended for commercial use and is not open-source. You need a license key to work with the SDK.
|
|
7
|
+
Working with WANNA SDK is subject to [Terms of use](https://wanna.fashion/terms-trial).
|
|
8
|
+
Please review them before downloading the SDK and starting to use it.
|
|
16
9
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
* a short description of your project
|
|
20
|
-
* a link to your company website
|
|
21
|
-
* any other information you consider relevant
|
|
22
|
-
|
|
23
|
-
### Terms of use
|
|
24
|
-
|
|
25
|
-
Working with WANNA SDK is subject to [Terms of use](https://wanna.fashion/terms-trial). Please review them before downloading the SDK and starting to use it.
|
|
26
|
-
|
|
27
|
-
## Trial version limitations
|
|
28
|
-
|
|
29
|
-
* Only several specific models are supported. You'll have to buy the full version to work with your own 3D assets.
|
|
30
|
-
|
|
31
|
-
## Install the library
|
|
32
|
-
|
|
33
|
-
### With NPM:
|
|
34
|
-
|
|
35
|
-
1. Add the `@wannaby/wanna-sdk` package to your project dependencies:
|
|
36
|
-
|
|
37
|
-
```
|
|
38
|
-
yarn add @wannaby/wanna-sdk
|
|
39
|
-
```
|
|
40
|
-
or
|
|
41
|
-
```
|
|
42
|
-
npm install @wannaby/wanna-sdk
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
2. Add the following rules into your Webpack configuration:
|
|
46
|
-
```javascript
|
|
47
|
-
rules: [
|
|
48
|
-
...
|
|
49
|
-
{
|
|
50
|
-
test: /@wannaby\/wanna-sdk\/.*iframe.html$/,
|
|
51
|
-
loader: 'file-loader',
|
|
52
|
-
// type: 'asset/resource', For webpack 5
|
|
53
|
-
},
|
|
54
|
-
{
|
|
55
|
-
test: /@wannaby\/wanna-sdk\/.*core.js$/,
|
|
56
|
-
loader: 'file-loader',
|
|
57
|
-
options: {
|
|
58
|
-
name: 'core.js',
|
|
59
|
-
},
|
|
60
|
-
// type: 'asset/resource', For webpack 5
|
|
61
|
-
// generator: {
|
|
62
|
-
// filename: 'core.js'
|
|
63
|
-
// }
|
|
64
|
-
},
|
|
65
|
-
]
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
**Note:** Check that **iframe.html** and **core.js** is processing just by this config, not some other. If instead of Webpack you use Rollup JS, or something similar, you have to add some rules like that to add core.js and iframe.html files into your public folder and get iframe.html path to import it.
|
|
69
|
-
|
|
70
|
-
3. Import WANNA SDK files:
|
|
71
|
-
|
|
72
|
-
```javascript
|
|
73
|
-
import wanna from '@wannaby/wanna-sdk';
|
|
74
|
-
import wannaIframe from '@wannaby/wanna-sdk/iframe.html';
|
|
75
|
-
import '@wannaby/wanna-sdk/core';
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
Now WANNA SDK is connected to your application.
|
|
79
|
-
|
|
80
|
-
### With local file:
|
|
81
|
-
|
|
82
|
-
1. Unzip the archive.
|
|
83
|
-
2. Host `iframe.html` and WANNA SDK scripts: `core.js` and `sdk.js`. For the example we assume that they are located in a `libs` folder alongside your scripts and HTMLs.
|
|
84
|
-
3. Add WANNA SDK script to your page:
|
|
85
|
-
```javascript
|
|
86
|
-
<script defer src="./libs/sdk.js"></script>
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
Now WANNA SDK is connected to your application, and will be available via the global `wanna` object.
|
|
10
|
+
Find more details on our [documentation portal](https://docs.wanna.fashion/web/licensing).
|
|
90
11
|
|
|
91
|
-
##
|
|
12
|
+
## Installation and use
|
|
92
13
|
|
|
93
|
-
|
|
14
|
+
See the description of the process on our [documentation portal](https://docs.wanna.fashion/web/vto/install).
|
|
94
15
|
|
|
95
|
-
## Requirements
|
|
16
|
+
## System Requirements
|
|
96
17
|
|
|
97
|
-
|
|
98
|
-
* iOS (for both iPhone and iPad devices):
|
|
99
|
-
* Safari 15 and later
|
|
100
|
-
* Safari 15 (in-app) and later
|
|
101
|
-
* Google Chrome on iOS 15 and later
|
|
102
|
-
* WebView (in general) on iOS 15 and later, including the most common messengers: WhatsApp, Facebook, Telegram, Snapchat, Instagram, LINE, KakaoTalk, WeChat
|
|
103
|
-
* Android:
|
|
104
|
-
* Google Chrome 83 and later
|
|
105
|
-
* Android WebView in the most common messengers: WhatsApp, Facebook, Telegram, Instagram, KakaoTalk, WeChat
|
|
106
|
-
* Android Browser 103 and later
|
|
107
|
-
* Samsung Internet 17.0 and later
|
|
18
|
+
See the list of supported environments on our [documentation portal](https://docs.wanna.fashion/web/requirements).
|