API biblioteki @orbito/api-lib
Biblioteka @orbito/api-lib to jedyny oficjalny sposób komunikacji modułu z platformą Orbito. Implementuje protokół komunikacyjny Orbito i udostępnia go jako proste API Node.js. Każdy moduł powinien instalować bibliotekę jako zależność produkcyjną.
npm install @orbito/api-lib
Paczka leży w firmowym rejestrze npm Orbito, nie na npmjs.org: npm install wymaga linii scope @orbito w ~/.npmrc (bez tokenu) — zob. Instalacja omm.
Dostępne moduły
| Moduł | Opis |
|---|---|
Core | Tożsamość modułu, rejestracja metod i hooków, wywoływanie innych modułów (także konkretnej instancji przez callInstanceMethod, od SDK 3.0.0), wychodzące zapytania HTTP |
Log | Logowanie zdarzeń widocznych w panelu Orbito |
Utils | Funkcje pomocnicze |
Pages | Rejestracja stron UI w panelu administracyjnym Orbito (od SDK 3.2.0 także automatyczne linki do stron — navbar i menu ustawień, placement + registerSettingsSections) |
Automation | Rejestracja akcji i triggerów silnika automatyzacji (od SDK 3.0.0 każda automatyzacja działa na wybranej instancji modułu) |
DB | Operacje na MongoDB – schematy, CRUD, indeksy, hooki cyklu życia |
Config | Konfiguracja modułu — magazyn ustawień + deklaratywny ekran konfiguracji w panelu (registerConfigBlocks, od SDK 2.3.0; przyciski akcji przy formularzu od SDK 3.3.0) |
Files | Bucket plików instalacji modułu — wgrywanie, odczyt, listowanie i kasowanie plików z deduplikacją po sumie kontrolnej (od SDK 3.6.0) |
Problems | Rejestr problemów firmy — zgłaszanie i kasowanie sytuacji, które użytkownik musi zobaczyć i naprawić, z deduplikacją po problemKey (od SDK 3.8.0) |
History | Wspólna historia zdarzeń firmy — tylko dopisywany rejestr tego, co stało się z zamówieniem, przesyłką czy dokumentem, z gotowym opisem dla użytkownika i relacjami do encji (od SDK 3.10.0) |
OAuth | Bilety callbacku OAuth — rdzeń odbiera przekierowanie dostawcy (Amazon, Allegro i inne), a moduł kończy logowanie metodą wywołaną w kontekście użytkownika, bez własnej publicznej strony (od SDK 4.2.0) |
Time | Daty w strefie czasowej firmy — parsowanie, formatowanie, granice dnia i dodawanie dni kalendarzowych niezależnie od TZ kontenera (od SDK 4.3.0) |
Mail | Wysyłanie wiadomości e-mail przez rdzeń Orbito — z serwera Orbito lub własnego SMTP firmy (od SDK 2.3.0) |
Templates | Zmienne szablonów wiadomości firmy — grupy pól z handlerem, dostępne w globalnym edytorze szablonów i w akcjach automatyzacji (od SDK 4.0.0) |
Lock | Rozproszone blokady do zapobiegania konfliktom w operacjach współbieżnych |
| Uprawnienia | System uprawnień per moduł — rejestracja i sprawdzanie uprawnień użytkownika (od SDK 2.1.0) |
Importowanie
Do importu używamy destrukturyzacji – pobierz tylko to, czego potrzebujesz:
// Wszystkie moduły
const { Log, Core, Utils, Pages, Automation, DB, Config, Files, OAuth, Time, Mail, Templates } = require('@orbito/api-lib');
// Tylko potrzebne
const { Core, Log } = require('@orbito/api-lib');
CommonJS
Biblioteka używa formatu CommonJS (require). Upewnij się, że plik package.json Twojego modułu nie zawiera "type": "module", lub używaj plików .cjs.