@cloudsignal/pwa-sdk 1.2.4 → 2.1.0

package/CHANGELOG.md

@@ -5,37 +5,39 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.2.3] - 2026-01-19
+## [2.1.0] - 2026-04-23
 
 ### Added
 
-- **Auto Installation Tracking** - Automatically registers PWA installations with the backend when detected
-- `registerInstallation()` method for manual installation tracking without push subscription
-- `isInstallationRegistered()` method to check if installation is already tracked
-- `getInstallationId()` method to get stored installation registration ID
-- `install:registered` event emitted when installation is registered with backend
-- Installation tracking works with both HMAC (anonymous) and JWT (authenticated) modes
+- **Auto-register PWA installations on `initialize()`** — when the SDK detects it is running in standalone / installed mode, it automatically POSTs to `/api/v1/registration/install-only` so the device shows up in the Clients tab without requiring the user to enable push first. A subsequent `registerForPush()` call upgrades the same row server-side (matched by browser fingerprint).
+- `registerInstallation()` public method on `CloudSignalPWA` for manual install tracking.
+- `install:registered` event fires after the backend acknowledges the install registration. Payload: `{ registrationId }`.
+- Installation registrations are guarded by a localStorage flag (`isInstallationRegistered` / `markInstallationRegistered`) so repeat `initialize()` calls within the same storage session are no-ops.
 
-### Changed
+### Fixed
+
+- Restores the auto-install-registration feature originally shipped in 1.2.3 that was inadvertently removed in commit `42935abf`.
+
+## [2.0.0] - 2026-04-23
 
-- `initialize()` now auto-calls `registerInstallation()` when PWA is detected as installed
-- Prevents duplicate registrations using localStorage tracking
+### Changed (BREAKING)
 
-### Documentation
+- Renamed the HMAC-mode config field `organizationSecret` → `organizationPublishableKey`. The value has always been an organization publishable key (`pk_*`), safe to ship in browser code; the previous name was misleading and invited customers to paste `sk_*` server-only keys by mistake.
+- Companion env var (dashboard snippets + docs): `NEXT_PUBLIC_CLOUDSIGNAL_SECRET` → `NEXT_PUBLIC_CLOUDSIGNAL_PUBLISHABLE_KEY`.
+- Error messages and JSDoc updated to reflect the new name.
 
-- **Type Corrections**: Fixed `registration.registrationId`, `InstallationState` object type, `queueOfflineRequest` signature, `processOfflineQueue` return type
-- **Prerequisites Section**: Added environment variable configuration guide
-- **Service Worker Setup**: Added root placement guidance, scope configuration, Workbox/Serwist coexistence patterns
-- **Framework Integrations**: Added Next.js App Router guide with dynamic imports, Supabase Auth integration
-- **Event Documentation**: Complete event list with handler signatures
-- **Troubleshooting**: Service worker, permission, iOS, and token/auth issues
-- **Production Checklist**: Pre-deployment verification steps
-- **Migration Guides**: From Firebase Cloud Messaging and OneSignal
+### Migration
 
-### Backend Support
+```diff
+ new CloudSignalPWA({
+   organizationId: '...',
+-  organizationSecret: 'pk_...',
++  organizationPublishableKey: 'pk_...',
+   serviceId: '...',
+ })
+```
 
-- `/api/v1/registration/install-only` endpoint now supports JWT authentication
-- Installation registrations include `auth_method`, `auth_provider`, and `idp_user_id` for JWT mode
+JWT mode (`userToken`) is unaffected. Wire protocol (`X-CloudSignal-*` headers) and signing algorithm are unchanged — servers need no update.
 
 ## [1.2.0] - 2025-01-17