@orchesty/connector-idoklad 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 +77 -0
- package/dist/package.json +2 -2
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# iDoklad Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-idoklad)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for iDoklad, a web service for managing and issuing invoices.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**OAuth 2.0**
|
|
11
|
+
|
|
12
|
+
This connector uses the iDoklad OAuth 2.0 authorization flow with `idoklad_api` and `offline_access` scopes. After entering your credentials in Orchesty, you will be redirected to iDoklad to authorize access.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `client_id` | OAuth Client ID from the iDoklad developer portal |
|
|
17
|
+
| `client_secret` | OAuth Client Secret from the iDoklad developer portal |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `IDokladCreateNewContactConnector` | Connector | Creates a new contact via `POST /v3/Contacts` |
|
|
24
|
+
| `IDokladNewInvoiceReceivedConnector` | Connector | Creates a new received invoice via `POST /v3/ReceivedInvoices` |
|
|
25
|
+
|
|
26
|
+
## Setup
|
|
27
|
+
|
|
28
|
+
### Credentials
|
|
29
|
+
|
|
30
|
+
1. Log in to the [iDoklad](https://app.idoklad.cz) portal.
|
|
31
|
+
2. Navigate to **Settings → API** and register your application to obtain a **Client ID** and **Client Secret**.
|
|
32
|
+
3. Add the Orchesty OAuth callback URL to the authorized redirect URIs.
|
|
33
|
+
4. In Orchesty, open the iDoklad application settings, enter the credentials, and complete the OAuth authorization flow.
|
|
34
|
+
|
|
35
|
+
### API Documentation
|
|
36
|
+
|
|
37
|
+
iDoklad API Reference: [https://api.idoklad.cz/Help/v3/en](https://api.idoklad.cz/Help/v3/en)
|
|
38
|
+
|
|
39
|
+
## Installation & Usage
|
|
40
|
+
|
|
41
|
+
Install the package:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm install @orchesty/connector-idoklad @orchesty/nodejs-sdk
|
|
45
|
+
# or
|
|
46
|
+
pnpm add @orchesty/connector-idoklad @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 { OAuth2Provider } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Provider/OAuth2/OAuth2Provider';
|
|
54
|
+
import IDokladApplication from '@orchesty/connector-idoklad/dist/IDokladApplication';
|
|
55
|
+
import IDokladCreateNewContactConnector from '@orchesty/connector-idoklad/dist/Connector/IDokladCreateNewContactConnector';
|
|
56
|
+
import IDokladNewInvoiceReceivedConnector from '@orchesty/connector-idoklad/dist/Connector/IDokladNewInvoiceReceivedConnector';
|
|
57
|
+
|
|
58
|
+
const app = new IDokladApplication(container.get(OAuth2Provider));
|
|
59
|
+
container.setApplication(app);
|
|
60
|
+
container.setNode(new IDokladCreateNewContactConnector(), app);
|
|
61
|
+
container.setNode(new IDokladNewInvoiceReceivedConnector(), app);
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
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.
|
|
67
|
+
|
|
68
|
+
## Contributing
|
|
69
|
+
|
|
70
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
71
|
+
|
|
72
|
+
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.
|
|
73
|
+
|
|
74
|
+
All contributions should include:
|
|
75
|
+
- Source code in `src/` following the existing connector structure
|
|
76
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
77
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-idoklad",
|
|
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-idoklad",
|
|
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"
|