@orbito/api-lib (2.3.0)
Installation
@orbito:registry=https://git.kozminski.net.pl/api/packages/orbito/npm/npm install @orbito/api-lib@2.3.0"@orbito/api-lib": "2.3.0"About this package
Orbito API
API obsługujące protokół binarny
DB - szybki start
Modul DB udostepnia proste operacje na kolekcjach (find, insert, update, delete)
oraz klase Schema, ktora waliduje dane przed zapisem i pozwala definiowac hooki.
Definicja schematu
const { DB } = require('@orbito/api-lib');
const OrdersSchema = new DB.Schema('orders', {
orderNumber: { type: 'string', required: true },
cart: { type: 'array', items: { type: 'object' }, default: [] },
total: { type: 'number', default: 0 },
createdAt: { type: 'date', default: () => new Date() }
});
OrdersSchema.pre('validate', function(data) {
if (data.cart && Array.isArray(data.cart)) {
data.total = data.cart.reduce((sum, item) => sum + (item.price * item.quantity), 0);
}
});
OrdersSchema.post('create', function(doc) {
// np. emit event po utworzeniu
});
DB.createIndex('orders', { orderNumber: 1 }, { unique: true });
module.exports = OrdersSchema;
Operacje na danych
const { DB } = require('@orbito/api-lib');
// create z walidacja schematu
const doc = await OrdersSchema.create({
orderNumber: 'ORD-123',
cart: [{ price: 10, quantity: 2 }]
});
// find / findOne
const list = await OrdersSchema.find({}, 50, 0, { createdAt: -1 });
const one = await OrdersSchema.findOne({ orderNumber: 'ORD-123' });
// update
const result = await OrdersSchema.update({ _id: doc._id }, { $set: { total: 30 } });
// delete
const deleted = await OrdersSchema.delete({ _id: doc._id });
Uwagi
Schemaautomatycznie mapujeObjectIdw definicji na validatorobjectID.- W
find(schemat) string w formacie 24-hex zostanie rzutowany naObjectId, jesli pole w schemacie ma typObjectId. - Operacje
DB.find/insert/update/delete/createIndexdzialaja bezposrednio na kolekcjach. - Nazwy kolekcji sa logiczne/surowe (np.
"orders") - rdzen sam dokleja namespace{companyId}_{moduleCode}_{collection}. Nie prefiksuj kolekcjicompanyIdi nie dodawajcompanyIddo filtrow zapytan - izolacja danych per firma jest wymuszana przez rdzen.
Config - zmienne konfiguracyjne modulu
Modul Config to generyczny magazyn konfiguracji przechowywany przez rdzen
(per firma + modul). Konfiguracja przezywa wylaczenie/wlaczenie modulu oraz
aktualizacje wersji. Wartosci moga byc dowolnymi typami BSON (max 64 KB) -
wieksze dane trzymaj w DB.
const { Config } = require('@orbito/api-lib');
// config globalny instancji modulu
await Config.set('inpost.api_key', 'abc123');
let apiKey = await Config.get('inpost.api_key');
let mode = await Config.get('inpost.mode', 'sandbox'); // wartosc domyslna gdy klucz nie istnieje
// config per uzytkownik (userId zwykle z ctx.userId)
await Config.forUser(ctx.userId).set('print_label', true);
let autoPrint = await Config.forUser(ctx.userId).get('print_label', false);
// pozostale operacje
let all = await Config.getAll(); // { 'inpost.api_key': 'abc123', ... }
await Config.delete('inpost.api_key'); // true gdy klucz istnial
- Scope (firma + modul) wynika z tozsamosci polaczenia - modul nie ma dostepu do konfiguracji innych firm ani innych modulow.
- Scope globalny i scope'y per-uzytkownik sa calkowicie rozlaczne
(
getAll()nie zwraca wpisow per-uzytkownik). getzwraca wartosc domyslna tylko gdy klucz NIE istnieje - zapisanynulljest zwracany jakonull.- Brak cache po stronie SDK - kazdy
getto odczyt z rdzenia, dzieki czemu wiele procesow tego samego modulu zawsze widzi spójne wartosci.
Config blocks - deklaratywna konfiguracja modulu
Zamiast budowac wlasna strone ustawien, modul deklaruje bloki konfiguracyjne -
frontend Orbito renderuje z nich generyczny formularz (format schemy wspolny
z automatyzacjami, patrz DeclarativeSchema.js). Po pozytywnej walidacji rdzen
sam zapisuje wartosci do config store pod kluczami ${blockKey}.${fieldKey}.
const { Config } = require('@orbito/api-lib');
const { PropertyType, DisplayFormat } = Config;
Config.registerConfigBlocks({
general: {
title: { pl: 'Ustawienia polaczenia', en: 'Connection settings' },
scope: 'global', // jeden zestaw wartosci per firma
schema: async (actualConfig) => ({
apiKey: { type: PropertyType.STRING, format: DisplayFormat.SECRET, name: 'Klucz API', required: true },
hint: { type: PropertyType.INFO, name: 'Klucz znajdziesz w panelu uslugi' } // tylko do wyswietlania, nie jest zapisywane
}),
validate: async (params, raport) => {
if (!params.apiKey) raport.addError('apiKey', 'Klucz API jest wymagany');
}
},
print: {
title: { pl: 'Preferencje wydruku', en: 'Print preferences' },
scope: 'user', // kazdy uzytkownik edytuje swoje wartosci
schema: { autoPrint: { type: PropertyType.BOOLEAN, name: 'Drukuj automatycznie' } }
}
});
// odczyt w metodach modulu - klucz bloku jest prefiksem:
let apiKey = await Config.get('general.apiKey');
let autoPrint = await Config.forUser(ctx.userId).get('print.autoPrint', false);
title.enjest wymagane (jezyk zapasowy);titlemoze byc tez stringiem.schemato obiekt albo (async) funkcja(actualConfig) => schema- zestaw pol moze zalezec od obecnej konfiguracji.validate(opcjonalne) dostaje KOMPLETNE dane bloku po zapisie (sekrety juz podstawione) i raportuje bledy przezraport.addError(field, message)- jakikolwiek blad odrzuca zapis.- Wartosci pol SECRET nigdy nie wracaja do frontu; puste pole SECRET przy zapisie oznacza "bez zmian".
- Schematy i validate zostaja w module (rdzen pyta o nie on-demand), ale METADANE blokow (klucz/tytul/scope) sa wysylane do rdzenia przy rejestracji i automatycznie ponownie po reconnect - dzieki temu rdzen wie, ze modul ma konfiguracje (przycisk "Konfiguruj"), bez budzenia kontenera.
Mail - wysylanie e-maili
Modul Mail wysyla e-maile przez rdzen Orbito. Rdzen opakowuje tresc w szablon
brandingowy (logo + stopka "Wiadomosc wyslana przez modul X w systemie Orbito")
i wysyla przez serwer nadawczy wybrany przez firme: globalny serwer Orbito albo
wlasny SMTP firmy (konfigurowany w ustawieniach firmy). Modul nie wybiera
transportu sam - firma i tozsamosc modulu wynikaja z polaczenia.
const { Mail } = require('@orbito/api-lib');
await Mail.sendMail(
'klient@example.com',
'Twoje zamowienie zostalo wyslane',
'<p>Zamowienie <b>#1234</b> zostalo nadane.</p>',
{ title: 'Zamowienie wyslane', replyTo: 'sklep@firma.pl' } // opcjonalne
);
contentto WNETRZE szablonu - nie wysylaj pelnego dokumentu HTML (bez<html>/<body>).- Limity rdzenia: tresc max 256 KB, bez zalacznikow, max 30 maili/min na firme.
- Gdy firma uzywa wlasnego SMTP, bledy jej serwera sa propagowane do modulu - nie ma cichego fallbacku na serwer Orbito.
Dependencies
Dependencies
| ID | Version |
|---|---|
| bson | ^6.10.4 |
| fastest-validator | ^1.19.1 |
Development Dependencies
| ID | Version |
|---|---|
| eslint | ^8.29.0 |
| eslint-plugin-jest | ^28.11.0 |
| jest | ^29.7.0 |
| nodemon | ^2.0.19 |
| supertest | ^7.0.0 |