@bagdock/analytics - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

dist/index.d.mts

@@ -1,2 +0,2 @@
-type EventType = 'click' | 'lead' | 'sale' | 'signup' | 'embed_render' | 'share' | 'qr_scan' | 'deep_link_open' | 'page_view' | 'reward_redeemed' | 'points_earned' | 'referral_completed';
+type EventType = 'click' | 'lead' | 'sale' | 'signup' | 'embed_render' | 'share' | 'qr_scan' | 'deep_link_open' | 'page_view' | 'reward_redeemed' | 'points_earned' | 'referral_completed' | 'rental.reserved' | 'rental.paid' | 'rental.activated' | 'rental.moved_in' | 'rental.moved_out' | 'rental.renewed' | 'rental.cancelled' | 'rental.completed' | 'deal.created' | 'deal.stage_changed' | 'deal.won' | 'deal.lost' | 'unit.occupied' | 'unit.vacated' | 'checkout.started' | 'checkout.completed' | 'checkout.abandoned' | 'marketing_event.attendance_recorded' | 'contact.identified' | 'contact.lifecycle_changed';
 interface TrackableEvent {
@@ -3,0 +3,0 @@ eventType: EventType;

dist/index.d.ts

@@ -1,2 +0,2 @@
-type EventType = 'click' | 'lead' | 'sale' | 'signup' | 'embed_render' | 'share' | 'qr_scan' | 'deep_link_open' | 'page_view' | 'reward_redeemed' | 'points_earned' | 'referral_completed';
+type EventType = 'click' | 'lead' | 'sale' | 'signup' | 'embed_render' | 'share' | 'qr_scan' | 'deep_link_open' | 'page_view' | 'reward_redeemed' | 'points_earned' | 'referral_completed' | 'rental.reserved' | 'rental.paid' | 'rental.activated' | 'rental.moved_in' | 'rental.moved_out' | 'rental.renewed' | 'rental.cancelled' | 'rental.completed' | 'deal.created' | 'deal.stage_changed' | 'deal.won' | 'deal.lost' | 'unit.occupied' | 'unit.vacated' | 'checkout.started' | 'checkout.completed' | 'checkout.abandoned' | 'marketing_event.attendance_recorded' | 'contact.identified' | 'contact.lifecycle_changed';
 interface TrackableEvent {
@@ -3,0 +3,0 @@ eventType: EventType;

package.json

 {
   "name": "@bagdock/analytics",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Bagdock Analytics SDK — lightweight client-side event tracking with batching and dedup",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -162,2 +162,38 @@ ```
 
+## How to track self-storage lifecycle events
+
+Track key moments in the rental and deal lifecycle:
+
+```typescript
+// Rental reserved from checkout
+analytics.track({
+  eventType: 'rental.reserved',
+  operatorId: 'opreg_acme',
+  metadata: { unitId: 'unit_abc', facilitySlug: 'central-london' },
+})
+
+// Move-in completed
+analytics.track({
+  eventType: 'rental.moved_in',
+  operatorId: 'opreg_acme',
+  metadata: { rentalId: 'rent_xyz' },
+})
+
+// Deal won (converted to rental)
+analytics.track({
+  eventType: 'deal.won',
+  operatorId: 'opreg_acme',
+  valuePence: 14900,
+  metadata: { dealId: 'deal_123', stage: 'closed_won' },
+})
+
+// Checkout completed
+analytics.track({
+  eventType: 'checkout.completed',
+  operatorId: 'opreg_acme',
+  valuePence: 9900,
+  currency: 'GBP',
+})
+```
+
 ## How to track embed and widget events
@@ -268,5 +304,21 @@
 type EventType =
+  // Engagement
   | 'click' | 'lead' | 'sale' | 'signup' | 'embed_render'
   | 'share' | 'qr_scan' | 'deep_link_open' | 'page_view'
+  // Loyalty
   | 'reward_redeemed' | 'points_earned' | 'referral_completed'
+  // Self-storage lifecycle
+  | 'rental.reserved' | 'rental.paid' | 'rental.activated'
+  | 'rental.moved_in' | 'rental.moved_out'
+  | 'rental.renewed' | 'rental.cancelled' | 'rental.completed'
+  // Deals / CRM
+  | 'deal.created' | 'deal.stage_changed' | 'deal.won' | 'deal.lost'
+  // Units
+  | 'unit.occupied' | 'unit.vacated'
+  // Checkout
+  | 'checkout.started' | 'checkout.completed' | 'checkout.abandoned'
+  // Marketing
+  | 'marketing_event.attendance_recorded'
+  // Contact
+  | 'contact.identified' | 'contact.lifecycle_changed'
 ```
@@ -273,0 +325,0 @@

No alert changes

Improved metrics

Total package byte prevSize

42191

5.45%

Lines of code

686

0.29%

Number of lines in readme file

385

15.62%

No dependency changes