@orchesty/connector-wix 1.0.1 → 2.0.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.
- package/README.md +83 -0
- package/dist/package.json +2 -2
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Wix Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-wix)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Wix, a cloud-based web development platform and e-commerce solution for building online stores and websites.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**OAuth 2.0**
|
|
11
|
+
|
|
12
|
+
This connector uses the Wix OAuth 2.0 authorization flow. After entering your credentials in Orchesty, you will be redirected to Wix to authorize access.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `client_id` | Your Wix app Client ID |
|
|
17
|
+
| `client_secret` | Your Wix app Client Secret |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `WixCreateOrderConnector` | Connector | Creates a new store order via `POST /stores/v2/orders` |
|
|
24
|
+
| `WixCreateProductConnector` | Connector | Creates a new store product via `POST /stores/v1/products` |
|
|
25
|
+
| `WixGetOrderConnector` | Connector | Retrieves a single order by ID via `GET /stores/v2/orders/{id}` |
|
|
26
|
+
| `WixUpdateProductConnector` | Connector | Updates an existing product via `PATCH /stores/v1/products/{productId}` |
|
|
27
|
+
|
|
28
|
+
## Setup
|
|
29
|
+
|
|
30
|
+
### Credentials
|
|
31
|
+
|
|
32
|
+
1. Log in to the [Wix Developer Center](https://dev.wix.com/) and create or open your app.
|
|
33
|
+
2. Under **OAuth**, copy the **App ID** (Client ID) and **App Secret Key** (Client Secret).
|
|
34
|
+
3. Add the Orchesty redirect URL to the **Redirect URLs** list.
|
|
35
|
+
4. In Orchesty, open the Wix application settings, enter both values, and complete the OAuth authorization flow.
|
|
36
|
+
|
|
37
|
+
### API Documentation
|
|
38
|
+
|
|
39
|
+
Wix REST API: [https://dev.wix.com/docs/rest](https://dev.wix.com/docs/rest)
|
|
40
|
+
|
|
41
|
+
## Installation & Usage
|
|
42
|
+
|
|
43
|
+
Install the package:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm install @orchesty/connector-wix @orchesty/nodejs-sdk
|
|
47
|
+
# or
|
|
48
|
+
pnpm add @orchesty/connector-wix @orchesty/nodejs-sdk
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Register the application and nodes in your Orchesty DI container:
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
55
|
+
import { OAuth2Provider } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Provider/OAuth2/OAuth2Provider';
|
|
56
|
+
import WixApplication from '@orchesty/connector-wix/dist/WixApplication';
|
|
57
|
+
import WixCreateOrderConnector from '@orchesty/connector-wix/dist/Connector/WixCreateOrderConnector';
|
|
58
|
+
import WixCreateProductConnector from '@orchesty/connector-wix/dist/Connector/WixCreateProductConnector';
|
|
59
|
+
import WixGetOrderConnector from '@orchesty/connector-wix/dist/Connector/WixGetOrderConnector';
|
|
60
|
+
import WixUpdateProductConnector from '@orchesty/connector-wix/dist/Connector/WixUpdateProductConnector';
|
|
61
|
+
|
|
62
|
+
const app = new WixApplication(container.get(OAuth2Provider));
|
|
63
|
+
container.setApplication(app);
|
|
64
|
+
container.setNode(new WixCreateOrderConnector(), app);
|
|
65
|
+
container.setNode(new WixCreateProductConnector(), app);
|
|
66
|
+
container.setNode(new WixGetOrderConnector(), app);
|
|
67
|
+
container.setNode(new WixUpdateProductConnector(), app);
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## License
|
|
71
|
+
|
|
72
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
73
|
+
|
|
74
|
+
## Contributing
|
|
75
|
+
|
|
76
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
77
|
+
|
|
78
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
79
|
+
|
|
80
|
+
All contributions should include:
|
|
81
|
+
- Source code in `src/` following the existing connector structure
|
|
82
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
83
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-wix",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.8"
|
|
21
21
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-wix",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"keywords": [],
|
|
12
12
|
"author": "info@hanaboso.com",
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
14
|
+
"@orchesty/nodejs-sdk": "^5.0.8"
|
|
15
15
|
},
|
|
16
16
|
"engines": {
|
|
17
17
|
"node": ">=24"
|