@orchesty/connector-flexi-bee 1.0.7 → 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.
Files changed (3) hide show
  1. package/README.md +113 -0
  2. package/dist/package.json +2 -2
  3. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,113 @@
1
+ # FlexiBee Connector
2
+
3
+ [![npm](https://img.shields.io/npm/v/@orchesty/connector-flexi-bee?color=15ba68)](https://www.npmjs.com/package/@orchesty/connector-flexi-bee)
4
+ [![License](https://img.shields.io/badge/license-Apache--2.0-15ba68)](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
5
+
6
+ An [Orchesty](https://orchesty.io) connector for FlexiBee (ABRA Flexi), a modern economic system designed for small companies.
7
+
8
+ ## Application Type
9
+
10
+ **Basic**
11
+
12
+ This connector authenticates against a self-hosted FlexiBee instance using either HTTP Basic auth (username + password) or a JSON session token obtained via the `/login-logout/login.json` endpoint. The session token is cached for up to 30 minutes.
13
+
14
+ | Field | Description |
15
+ |---|---|
16
+ | `flexibeeUrl` | Full URL of your FlexiBee instance (e.g. `https://demo.flexibee.eu`) |
17
+ | `user` | Your FlexiBee username |
18
+ | `password` | Your FlexiBee password |
19
+ | `auth` | Authentication method: `json` (session token) or `http` (Basic auth) |
20
+
21
+ ## Components
22
+
23
+ | Class | Type | Description |
24
+ |---|---|---|
25
+ | `FlexiBeeCreateFakturaPrijataConnector` | Connector | Creates a received invoice (`faktura-prijata`) |
26
+ | `FlexiBeeCreateFakturaPrijataPrilohaConnector` | Connector | Uploads a PDF attachment to a received invoice |
27
+ | `FlexiBeeCreateNewContactConnector` | Connector | Creates a new company/contact via the admin endpoint |
28
+ | `FlexiBeeCreateObjednavkaVydanaConnector` | Connector | Creates an issued purchase order (`objednavka-vydana`) |
29
+ | `FlexiBeeCreateSkladovyPohybConnector` | Connector | Creates a warehouse stock movement (`skladovy-pohyb`) |
30
+ | `FlexiBeeCreateZavazekConnector` | Connector | Creates a liability record (`zavazek`) |
31
+ | `FlexiBeeCreateZavazekPrilohaConnector` | Connector | Uploads a PDF attachment to a liability record |
32
+ | `FlexiBeeGetCenikKartyConnector` | Connector | Fetches pricelist card details by reference URL |
33
+ | `FlexiBeeGetCompaniesConnector` | Connector | Lists all companies on the FlexiBee instance |
34
+ | `FlexiBeeGetContactsArrayConnector` | Connector | Retrieves an array of contacts (`kontakt.json`) |
35
+ | `FlexiBeeGetFakturaPrijataConnector` | Connector | Fetches a single received invoice by ID |
36
+ | `FlexiBeeGetObjednavkaVydanaConnector` | Connector | Fetches a single issued order by ID |
37
+ | `FlexiBeeGetSarzeExpiraceKartyConnector` | Connector | Fetches batch/expiry records for a stock card |
38
+ | `FlexiBeeGetZavazekConnector` | Connector | Fetches a single liability record by ID |
39
+ | `FlexiBeeUpdateObjednavkaPrijataConnector` | Connector | Updates a received purchase order |
40
+ | `FlexiBeeUpdateSkladovyPohybConnector` | Connector | Updates a warehouse stock movement |
41
+ | `FlexiBeeCleneniDphBatch` | Batch | Paginated list of VAT membership classification records |
42
+ | `FlexiBeeCleneniKontrolniHlaseniBatch` | Batch | Paginated list of VAT control statement classification records |
43
+ | `FlexiBeeFormaDopravyBatch` | Batch | Paginated list of delivery/transport method codelist entries |
44
+ | `FlexiBeeFormaUhradyBatch` | Batch | Paginated list of payment method codelist entries |
45
+ | `FlexiBeeGetSkladovyPohybBatch` | Batch | Paginated list of warehouse stock movement records |
46
+ | `FlexiBeeObjednavkaPrijataBatch` | Batch | Paginated list of received orders |
47
+ | `FlexiBeeObjednavkaVydanaBatch` | Batch | Paginated list of issued orders |
48
+ | `FlexiBeePredpisZauctovaniBatch` | Batch | Paginated list of accounting posting templates |
49
+ | `FlexiBeeSkladoveKartyBatch` | Batch | Paginated list of warehouse stock cards |
50
+ | `FlexiBeeStitkyBatch` | Batch | Paginated list of labels/tags |
51
+ | `FlexiBeeStrediskoBatch` | Batch | Paginated list of cost centre records |
52
+ | `FlexiBeeTypFakturyPrijateBatch` | Batch | Paginated list of received invoice types |
53
+ | `FlexiBeeUcetBatch` | Batch | Paginated list of chart of accounts entries |
54
+ | `FlexiBeeZakazkaBatch` | Batch | Paginated list of job/project (zakázka) records |
55
+
56
+ ## Setup
57
+
58
+ ### Credentials
59
+
60
+ FlexiBee is a self-hosted application. You need your own FlexiBee instance to use this connector. Contact your system administrator or [ABRA Software](https://www.flexibee.eu) for a developer licence and API access.
61
+
62
+ In Orchesty, fill in:
63
+ - **flexibeeUrl** — the full URL of your FlexiBee installation
64
+ - **user** / **password** — your FlexiBee login credentials
65
+ - **auth** — set to `json` for session token auth (recommended) or `http` for Basic auth
66
+
67
+ ### API Documentation
68
+
69
+ FlexiBee REST API: [https://www.flexibee.eu/api/](https://www.flexibee.eu/api/)
70
+
71
+ ## Installation & Usage
72
+
73
+ Install the package:
74
+
75
+ ```bash
76
+ npm install @orchesty/connector-flexi-bee @orchesty/nodejs-sdk
77
+ # or
78
+ pnpm add @orchesty/connector-flexi-bee @orchesty/nodejs-sdk
79
+ ```
80
+
81
+ The `FlexiBeeApplication` requires `CurlSender` and `DatabaseClient` from the SDK:
82
+
83
+ ```typescript
84
+ import { container } from '@orchesty/nodejs-sdk';
85
+ import CurlSender from '@orchesty/nodejs-sdk/dist/lib/Transport/Curl/CurlSender';
86
+ import DatabaseClient from '@orchesty/nodejs-sdk/dist/lib/Storage/Database/Client';
87
+ import FlexiBeeApplication from '@orchesty/connector-flexi-bee/dist/FexiBeeApplication';
88
+ import FlexiBeeCreateFakturaPrijataConnector from '@orchesty/connector-flexi-bee/dist/Connector/FlexiBeeCreateFakturaPrijataConnector';
89
+ import FlexiBeeGetCompaniesConnector from '@orchesty/connector-flexi-bee/dist/Connector/FlexiBeeGetCompaniesConnector';
90
+ import FlexiBeeObjednavkaPrijataBatch from '@orchesty/connector-flexi-bee/dist/Batch/FlexiBeeObjednavkaPrijataBatch';
91
+
92
+ const app = new FlexiBeeApplication(container.get(CurlSender), container.get(DatabaseClient));
93
+ container.setApplication(app);
94
+ container.setNode(new FlexiBeeCreateFakturaPrijataConnector(), app);
95
+ container.setNode(new FlexiBeeGetCompaniesConnector(), app);
96
+ container.setNode(new FlexiBeeObjednavkaPrijataBatch(), app);
97
+ // ... register additional connectors and batches as needed
98
+ ```
99
+
100
+ ## License
101
+
102
+ 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.
103
+
104
+ ## Contributing
105
+
106
+ Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
107
+
108
+ 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.
109
+
110
+ All contributions should include:
111
+ - Source code in `src/` following the existing connector structure
112
+ - Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
113
+ - An updated `CHANGELOG.md` entry
package/dist/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orchesty/connector-flexi-bee",
3
3
  "description": "",
4
- "version": "1.0.6",
4
+ "version": "1.0.7",
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": "^4.3.6"
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-flexi-bee",
3
3
  "description": "",
4
- "version": "1.0.7",
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": "^4.3.6"
14
+ "@orchesty/nodejs-sdk": "^5.0.8"
15
15
  },
16
16
  "engines": {
17
17
  "node": ">=24"