@rajeev02/app-shell 0.2.0 → 0.2.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.
- package/README.md +16 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,6 +17,22 @@ Part of [Rajeev SDK](https://github.com/Rajeev02/rajeev-sdk) — cross-platform
|
|
|
17
17
|
- **Form engine** — Multi-step forms with Indian ID validation (Aadhaar, PAN, IFSC, GSTIN, pincode)
|
|
18
18
|
- **Analytics** — Event tracking with session management, user properties, and batched uploads
|
|
19
19
|
|
|
20
|
+
## ⚠️ Important: Backend Services Required
|
|
21
|
+
|
|
22
|
+
This is a **client-side orchestration layer** — it manages state, caching, and offline queues. Several modules require your own backend services:
|
|
23
|
+
|
|
24
|
+
| Module | Backend required? | What you need |
|
|
25
|
+
| -------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `ApiClient` | **Yes** | Your REST API server (set as `baseUrl`) |
|
|
27
|
+
| `ChatEngine` | **Yes** | WebSocket or real-time server ([Firebase](https://firebase.google.com), [Ably](https://ably.com), [Socket.io](https://socket.io)) |
|
|
28
|
+
| `AnalyticsEngine` | **Yes** | Analytics endpoint or service ([Mixpanel](https://mixpanel.com), [Amplitude](https://amplitude.com), [PostHog](https://posthog.com), or custom) |
|
|
29
|
+
| `FeatureFlagManager` | **Yes** | Feature flag service ([LaunchDarkly](https://launchdarkly.com), [Unleash](https://www.getunleash.io/), or custom API) |
|
|
30
|
+
| `FormEngine` | **Yes** | Form submission endpoint (`onSubmit` callback) |
|
|
31
|
+
| `CartManager` | **No** | Client-side state only (GST calculation, coupons) |
|
|
32
|
+
| `OnboardingManager` | **No** | Client-side state only (slide progress, completion) |
|
|
33
|
+
|
|
34
|
+
**How callbacks work:** Modules like `ApiClient`, `ChatEngine`, and `AnalyticsEngine` accept configuration callbacks (`onRefreshToken`, `onFlush`, `onSubmit`) that call **your backend endpoints**. The library manages retry, caching, and offline queuing around them.
|
|
35
|
+
|
|
20
36
|
## Platform Support
|
|
21
37
|
|
|
22
38
|
| Platform | Engine | Status |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rajeev02/app-shell",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Feature-Slice app architecture — API client, navigation, onboarding, chat, video, forms, cart, state, analytics",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"author": "Rajeev Kumar Joshi <rajeevjoshi91@gmail.com> (https://rajeev02.github.io)",
|