@orchesty/connector-heureka-feed 1.0.1 → 2.0.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 +76 -0
- package/dist/package.json +3 -3
- package/package.json +7 -4
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Heureka Feed Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-heureka-feed)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Heureka, the largest shopping portal and price comparison site on the Czech Internet.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic (feed URL)**
|
|
11
|
+
|
|
12
|
+
This connector does not authenticate against Heureka's API. Instead, it fetches XML product and availability feed files from user-provided URLs and parses the XML data for further processing in Orchesty.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `product-feed` | Full URL of your Heureka product XML feed |
|
|
17
|
+
| `availability-feed` | Full URL of your Heureka availability XML feed |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `HeurekaProductFeedConnector` | Connector | Fetches and parses the Heureka product XML feed from the configured URL |
|
|
24
|
+
| `HeurekaAvailabilityFeedConnector` | Connector | Fetches and parses the Heureka availability XML feed from the configured URL |
|
|
25
|
+
|
|
26
|
+
## Setup
|
|
27
|
+
|
|
28
|
+
### Credentials
|
|
29
|
+
|
|
30
|
+
1. Generate your Heureka product feed and availability feed URLs in your e-shop or feed management tool.
|
|
31
|
+
2. In Orchesty, open the Heureka Feed application settings and fill in:
|
|
32
|
+
- **Product feed url** — full URL to your product XML feed
|
|
33
|
+
- **Availability feed url** — full URL to your availability XML feed
|
|
34
|
+
|
|
35
|
+
### Feed Format Documentation
|
|
36
|
+
|
|
37
|
+
Heureka XML Feed Format: [https://sluzby.heureka.cz/napoveda/xml-feed/](https://sluzby.heureka.cz/napoveda/xml-feed/)
|
|
38
|
+
|
|
39
|
+
## Installation & Usage
|
|
40
|
+
|
|
41
|
+
Install the package:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm install @orchesty/connector-heureka-feed @orchesty/nodejs-sdk
|
|
45
|
+
# or
|
|
46
|
+
pnpm add @orchesty/connector-heureka-feed @orchesty/nodejs-sdk
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Register the application and nodes in your Orchesty DI container:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
53
|
+
import HeurekaFeedApplication from '@orchesty/connector-heureka-feed/dist/HeurekaFeedApplication';
|
|
54
|
+
import HeurekaProductFeedConnector from '@orchesty/connector-heureka-feed/dist/Connector/HeurekaProductFeedConnector';
|
|
55
|
+
import HeurekaAvailabilityFeedConnector from '@orchesty/connector-heureka-feed/dist/Connector/HeurekaAvailabilityFeedConnector';
|
|
56
|
+
|
|
57
|
+
const app = new HeurekaFeedApplication();
|
|
58
|
+
container.setApplication(app);
|
|
59
|
+
container.setNode(new HeurekaProductFeedConnector(), app);
|
|
60
|
+
container.setNode(new HeurekaAvailabilityFeedConnector(), app);
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
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.
|
|
66
|
+
|
|
67
|
+
## Contributing
|
|
68
|
+
|
|
69
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
70
|
+
|
|
71
|
+
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.
|
|
72
|
+
|
|
73
|
+
All contributions should include:
|
|
74
|
+
- Source code in `src/` following the existing connector structure
|
|
75
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
76
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-heureka-feed",
|
|
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",
|
|
@@ -17,8 +17,8 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
21
|
-
"fast-xml-parser": "^5.
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.13",
|
|
21
|
+
"fast-xml-parser": "^5.10.1"
|
|
22
22
|
},
|
|
23
23
|
"engines": {
|
|
24
24
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,18 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-heureka-feed",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
|
-
"repository":
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors"
|
|
10
|
+
},
|
|
8
11
|
"files": [
|
|
9
12
|
"dist"
|
|
10
13
|
],
|
|
11
14
|
"keywords": [],
|
|
12
15
|
"author": "info@hanaboso.com",
|
|
13
16
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
15
|
-
"fast-xml-parser": "^5.
|
|
17
|
+
"@orchesty/nodejs-sdk": "^5.0.13",
|
|
18
|
+
"fast-xml-parser": "^5.10.1"
|
|
16
19
|
},
|
|
17
20
|
"engines": {
|
|
18
21
|
"node": ">=24"
|