@tekrom/tsoft-app-gate 0.1.0 → 0.1.1

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 (2) hide show
  1. package/README.md +50 -0
  2. package/package.json +5 -1
package/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # T-Soft App Gate
2
+
3
+ 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.
4
+
5
+ ## Özellikler
6
+ - `createApp` ile API anahtarınıza ve mağaza bilgilerinize bağlı bir köprü kurar.
7
+ - `setNavigationMenu` çağrısı ile T-Soft yönetim menüsünü uygulamanıza göre güncellemenizi sağlar.
8
+ - `showToast` sayesinde panel üzerindeki kullanıcıya başarı/başarısızlık bildirimleri gönderebilirsiniz.
9
+ - Tarayıcı `postMessage` altyapısını kullanır, böylece uygulamanız iframe içinde güvenle çalışabilir.
10
+
11
+ ## Kurulum
12
+ ```bash
13
+ npm install @tekrom/tsoft-app-gate
14
+ ```
15
+
16
+ ## Hızlı Başlangıç
17
+ TypeScript örneği:
18
+
19
+ ```ts
20
+ import { createApp, setNavigationMenu, showToast } from '@tekrom/tsoft-app-gate';
21
+
22
+ const app = createApp({
23
+ apiKey: 'TSOFT_API_KEY',
24
+ shopId: '12345',
25
+ host: 'tsoftpanel.com',
26
+ });
27
+
28
+ setNavigationMenu(app, [
29
+ { label: 'Siparişler', path: '/orders' },
30
+ { label: 'Kampanyalar', path: '/campaigns' },
31
+ ]);
32
+
33
+ showToast(app, { message: 'Kayıt başarıyla tamamlandı', variant: 'success' });
34
+ ```
35
+
36
+ ## Geliştirme
37
+ Projeyi kaynak koddan çalıştırmak için:
38
+
39
+ ```bash
40
+ npm install
41
+ npm run build
42
+ ```
43
+
44
+ `dist` klasörü TypeScript derlemesinden sonra npm paketine eklenecek çıktıları içerir. Yayın öncesi `npm run build` otomatik olarak çalışır (`prepublishOnly` scripti).
45
+
46
+ ## Katkı ve Destek
47
+ - Yeni aksiyonlar (ör. bildirim, modal, navigation) eklenmesini istiyorsanız issue açabilirsiniz.
48
+ - Hatalar veya iyileştirme önerileri için PR göndermekten çekinmeyin.
49
+
50
+ Tüm sorularınız için T-Soft ekibi ile iletişime geçebilirsiniz.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tekrom/tsoft-app-gate",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "T-Soft app gate core SDK",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -18,6 +18,10 @@
18
18
  "build": "tsc",
19
19
  "prepublishOnly": "npm run build"
20
20
  },
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "https://github.com/tekrom/tsoft-app-gate"
24
+ },
21
25
  "keywords": [
22
26
  "tsoft",
23
27
  "app-gate",