@tekrom/tsoft-app-gate
v0.1.1
Published
T-Soft app gate core SDK
Maintainers
Readme
T-Soft App Gate
T-Soft App Gate, T-Soft paneli ile panel üzerinde geliştirilen uygulamalar arasında güvenli bir köprü kurmak için hazırlanmış hafif bir SDK'dır. Amaç; uygulama geliştiricilerinin menü, bildirim, toast gibi arayüz bileşenlerine standart mesajlar üzerinden erişebilmesini sağlamaktır.
Özellikler
createAppile API anahtarınıza ve mağaza bilgilerinize bağlı bir köprü kurar.setNavigationMenuçağrısı ile T-Soft yönetim menüsünü uygulamanıza göre güncellemenizi sağlar.showToastsayesinde panel üzerindeki kullanıcıya başarı/başarısızlık bildirimleri gönderebilirsiniz.- Tarayıcı
postMessagealtyapısını kullanır, böylece uygulamanız iframe içinde güvenle çalışabilir.
Kurulum
npm install @tekrom/tsoft-app-gateHızlı Başlangıç
TypeScript örneği:
import { createApp, setNavigationMenu, showToast } from '@tekrom/tsoft-app-gate';
const app = createApp({
apiKey: 'TSOFT_API_KEY',
shopId: '12345',
host: 'tsoftpanel.com',
});
setNavigationMenu(app, [
{ label: 'Siparişler', path: '/orders' },
{ label: 'Kampanyalar', path: '/campaigns' },
]);
showToast(app, { message: 'Kayıt başarıyla tamamlandı', variant: 'success' });Geliştirme
Projeyi kaynak koddan çalıştırmak için:
npm install
npm run builddist klasörü TypeScript derlemesinden sonra npm paketine eklenecek çıktıları içerir. Yayın öncesi npm run build otomatik olarak çalışır (prepublishOnly scripti).
Katkı ve Destek
- Yeni aksiyonlar (ör. bildirim, modal, navigation) eklenmesini istiyorsanız issue açabilirsiniz.
- Hatalar veya iyileştirme önerileri için PR göndermekten çekinmeyin.
Tüm sorularınız için T-Soft ekibi ile iletişime geçebilirsiniz.
