native-update 2.0.0 → 3.1.0

package/docs/FIREBASE_INTEGRATION_TRACKER.md

@@ -1,321 +0,0 @@
-# Firebase Integration Tracker
-
-**Last Updated**: 2025-12-26
-**Scope**: Firebase is ONLY used in example-app, NOT in core plugin
-
----
-
-## 🎯 Firebase Usage Scope
-
-### ✅ WHERE Firebase IS Used
-- **example-app/firebase-backend/** - Example implementation showing how to build a backend with Firebase
-
-### ❌ WHERE Firebase IS NOT Used
-- Core plugin (`src/`) - **NO Firebase dependencies**
-- CLI tools (`cli/`) - **NO Firebase dependencies** (only CLI command to generate Firebase backend template)
-- Production backend (`production-backend/`) - Uses SQLite, **NOT Firebase**
-- Backend template (`backend-template/`) - Simple Express server, **NOT Firebase**
-
----
-
-## 📂 Firebase Files in example-app
-
-### Configuration Files
-| File | Purpose | Status | Issues |
-|------|---------|--------|--------|
-| `firebase.json` | Firebase project config | ✅ Complete | None |
-| `firestore.indexes.json` | Firestore indexes definition | ✅ Complete | All indexes defined |
-| `firestore.rules` | Firestore security rules | ✅ Complete | Needs review |
-| `storage.rules` | Cloud Storage security rules | ✅ Complete | Needs review |
-| `package.json` | Dependencies | ✅ Complete | None |
-| `tsconfig.json` | TypeScript config | ✅ Complete | None |
-| `.nvmrc` | Node version | ✅ Complete | Uses Node 22 |
-
-### Source Files
-| File | Purpose | Status | Firestore Queries | Indexes Needed |
-|------|---------|--------|-------------------|----------------|
-| `src/index.ts` | Main Functions entry | ✅ Complete | None | N/A |
-| `src/middleware/auth.ts` | Authentication middleware | ✅ Complete | None | N/A |
-| `src/routes/analytics.ts` | Analytics endpoints | ✅ Complete | ✅ Yes | ✅ Defined |
-| `src/routes/bundles.ts` | Bundle management | ✅ Complete | ✅ Yes | ✅ Defined |
-| `src/routes/updates.ts` | Update endpoints | ✅ Complete | ✅ Yes | ✅ Defined |
-| `src/utils/validation.ts` | Input validation | ✅ Complete | None | N/A |
-| `src/utils/version.ts` | Version comparison | ✅ Complete | None | N/A |
-
----
-
-## 🔍 Firestore Indexes Verification
-
-### Index 1: Bundles Collection
-**Purpose**: Query bundles by channel, version, and creation date
-
-```json
-{
-  "collectionGroup": "bundles",
-  "queryScope": "COLLECTION",
-  "fields": [
-    { "fieldPath": "channel", "order": "ASCENDING" },
-    { "fieldPath": "version", "order": "DESCENDING" },
-    { "fieldPath": "createdAt", "order": "DESCENDING" }
-  ]
-}
-```
-
-**Used In**: `src/routes/bundles.ts`, `src/routes/updates.ts`
-
-**Queries This Index Supports**:
-- Get latest bundle for a channel: `WHERE channel == 'production' ORDER BY version DESC, createdAt DESC`
-- Get bundles by channel and version: `WHERE channel == 'production' AND version >= '1.0.0' ORDER BY version DESC`
-
-**Status**: ✅ Index defined correctly
-
-**Verified**: ✅ All queries in code match index definition
-
----
-
-### Index 2: Update Logs Collection
-**Purpose**: Query update logs by app ID and timestamp
-
-```json
-{
-  "collectionGroup": "updateLogs",
-  "queryScope": "COLLECTION",
-  "fields": [
-    { "fieldPath": "appId", "order": "ASCENDING" },
-    { "fieldPath": "timestamp", "order": "DESCENDING" }
-  ]
-}
-```
-
-**Used In**: `src/routes/analytics.ts`
-
-**Queries This Index Supports**:
-- Get update logs for an app: `WHERE appId == 'com.example.app' ORDER BY timestamp DESC`
-- Get recent update logs: `WHERE appId == 'com.example.app' ORDER BY timestamp DESC LIMIT 100`
-
-**Status**: ✅ Index defined correctly
-
-**Verified**: ✅ All queries in code match index definition
-
----
-
-### Index 3: Analytics Collection
-**Purpose**: Query analytics events by event name and timestamp
-
-```json
-{
-  "collectionGroup": "analytics",
-  "queryScope": "COLLECTION",
-  "fields": [
-    { "fieldPath": "eventName", "order": "ASCENDING" },
-    { "fieldPath": "timestamp", "order": "DESCENDING" }
-  ]
-}
-```
-
-**Used In**: `src/routes/analytics.ts`
-
-**Queries This Index Supports**:
-- Get analytics for specific event: `WHERE eventName == 'update_success' ORDER BY timestamp DESC`
-- Get recent analytics: `WHERE eventName == 'update_success' ORDER BY timestamp DESC LIMIT 1000`
-
-**Status**: ✅ Index defined correctly
-
-**Verified**: ✅ All queries in code match index definition
-
----
-
-## 🔒 Firestore Security Rules Verification
-
-### Current Rules Overview
-
-#### Bundles Collection
-```javascript
-match /bundles/{bundleId} {
-  allow read: if request.auth != null;
-  allow write: if request.auth != null && request.auth.token.admin == true;
-}
-```
-
-**Analysis**:
-- ✅ Read requires authentication
-- ✅ Write requires admin role
-- ⚠️ Consider: May want public read for distribution
-
-#### Update Logs Collection
-```javascript
-match /updateLogs/{logId} {
-  allow read: if request.auth != null;
-  allow create: if request.auth != null;
-  allow update, delete: if request.auth != null && request.auth.token.admin == true;
-}
-```
-
-**Analysis**:
-- ✅ Read requires authentication
-- ✅ Create requires authentication (apps can log their updates)
-- ✅ Modify requires admin role
-
-#### Analytics Collection
-```javascript
-match /analytics/{analyticsId} {
-  allow read: if request.auth != null && request.auth.token.admin == true;
-  allow create: if request.auth != null;
-  allow update, delete: if false;
-}
-```
-
-**Analysis**:
-- ✅ Read requires admin (analytics should be private)
-- ✅ Create requires authentication (apps can send analytics)
-- ✅ No updates/deletes (append-only for data integrity)
-
-**Overall Security Status**: ✅ Rules are properly defined and secure
-
----
-
-## 📊 Firestore Queries Analysis
-
-### bundles.ts Queries
-
-#### Query 1: Get Latest Bundle
-```typescript
-db.collection('bundles')
-  .where('channel', '==', channel)
-  .orderBy('version', 'desc')
-  .orderBy('createdAt', 'desc')
-  .limit(1)
-```
-**Index Required**: ✅ Index 1 (bundles)
-**Status**: ✅ Covered by existing index
-
-#### Query 2: Get Bundle by Version
-```typescript
-db.collection('bundles')
-  .where('channel', '==', channel)
-  .where('version', '==', version)
-```
-**Index Required**: ✅ Index 1 (bundles) - Composite index supports equality queries
-**Status**: ✅ Covered by existing index
-
----
-
-### updates.ts Queries
-
-#### Query 1: Check for Updates
-```typescript
-db.collection('bundles')
-  .where('channel', '==', channel)
-  .where('version', '>', currentVersion)
-  .orderBy('version', 'desc')
-  .limit(1)
-```
-**Index Required**: ✅ Index 1 (bundles)
-**Status**: ✅ Covered by existing index
-
----
-
-### analytics.ts Queries
-
-#### Query 1: Get Analytics by Event
-```typescript
-db.collection('analytics')
-  .where('eventName', '==', eventName)
-  .orderBy('timestamp', 'desc')
-  .limit(limit)
-```
-**Index Required**: ✅ Index 3 (analytics)
-**Status**: ✅ Covered by existing index
-
-#### Query 2: Get Update Logs
-```typescript
-db.collection('updateLogs')
-  .where('appId', '==', appId)
-  .orderBy('timestamp', 'desc')
-  .limit(limit)
-```
-**Index Required**: ✅ Index 2 (updateLogs)
-**Status**: ✅ Covered by existing index
-
----
-
-## ✅ VERIFICATION SUMMARY
-
-### Indexes
-- ✅ All 3 indexes are properly defined
-- ✅ All queries in code are covered by indexes
-- ✅ No missing indexes
-- ✅ No unnecessary indexes
-
-### Security Rules
-- ✅ All collections have proper security rules
-- ✅ Authentication required for all operations
-- ✅ Admin-only operations properly restricted
-- ✅ Append-only analytics collection
-
-### Code Quality
-- ✅ All Firestore operations use proper TypeScript types
-- ✅ Error handling implemented
-- ✅ Validation before database operations
-
----
-
-## 🚀 Deployment Checklist
-
-### Before Deploying Firebase Backend
-
-- [ ] Review and approve `firestore.rules`
-- [ ] Review and approve `storage.rules`
-- [ ] Deploy indexes: `firebase deploy --only firestore:indexes`
-- [ ] Deploy rules: `firebase deploy --only firestore:rules`
-- [ ] Deploy storage rules: `firebase deploy --only storage`
-- [ ] Deploy functions: `firebase deploy --only functions`
-- [ ] Test all API endpoints
-- [ ] Verify authentication works
-- [ ] Test bundle upload/download
-- [ ] Verify analytics collection
-- [ ] Monitor for errors in Firebase Console
-
----
-
-## 📝 NOTES
-
-### Important Reminders
-
-1. **Firebase is OPTIONAL** - Core plugin works without Firebase
-2. **Example Only** - Firebase backend is just one example implementation
-3. **Alternatives Available**:
-   - `production-backend/` - Node.js + SQLite backend
-   - `backend-template/` - Simple Express server
-   - Custom backend - Users can build their own
-
-### Firebase-Specific Considerations
-
-1. **Cost Management**:
-   - Monitor Firestore reads/writes
-   - Consider caching frequently accessed bundles
-   - Use Cloud Storage for large bundles (cheaper than Firestore)
-
-2. **Performance**:
-   - All queries are properly indexed (no full scans)
-   - Limit results to prevent excessive reads
-   - Consider CDN for bundle distribution
-
-3. **Security**:
-   - All rules require authentication
-   - Admin operations properly restricted
-   - Consider IP allowlisting for admin operations
-
----
-
-## 🎯 FINAL STATUS
-
-**Firebase Integration Status**: ✅ **COMPLETE & VERIFIED**
-
-- ✅ All indexes properly defined
-- ✅ All queries covered by indexes
-- ✅ Security rules properly implemented
-- ✅ No missing configurations
-- ✅ Ready for deployment (example purposes)
-
-**No Firebase-related errors or issues found in the project.**

package/docs/FIREBASE_QUERIES_AND_INDEXES_AUDIT.md

@@ -1,221 +0,0 @@
-# Firebase Queries and Indexes Audit
-
-**Last Updated:** 2026-01-16
-**Audit Status:** ✅ COMPLETE
-**Build Status:** ✅ PASSING
-
----
-
-## Overview
-
-This document tracks all Firebase Firestore queries in the project and verifies that appropriate indexes exist for each query.
-
----
-
-## Collections Used
-
-| Collection | Purpose | Location |
-|------------|---------|----------|
-| `users` | User profiles and preferences | Website dashboard |
-| `apps` | Registered applications | Website dashboard |
-| `builds` | Build/release records | Website dashboard |
-| `drive_tokens` | Google Drive OAuth tokens | Google Drive integration |
-| `analytics` | Usage analytics events | Analytics tracking |
-| `manifests` | OTA update manifests | Rollouts page |
-
----
-
-## Firestore Rules Audit
-
-### Root `firestore.rules` and `website/firestore.rules`
-
-| Collection | Read | Write | Owner Check | Security Status |
-|------------|------|-------|-------------|-----------------|
-| `users/{userId}` | Owner only | Owner only | ✅ `userId == request.auth.uid` | ✅ Secure |
-| `apps/{appId}` | Owner only | Owner only | ✅ `resource.data.userId == request.auth.uid` | ✅ Secure |
-| `builds/{buildId}` | Owner only | Owner only | ✅ `resource.data.userId == request.auth.uid` | ✅ Secure |
-| `drive_tokens/{userId}` | Owner only | Owner only | ✅ `userId == request.auth.uid` | ✅ Secure |
-| `analytics/{eventId}` | Deny | Owner only | ✅ `request.resource.data.userId == request.auth.uid` | ✅ Secure (write-only) |
-| Default | Deny | Deny | N/A | ✅ Secure |
-
----
-
-## Firestore Indexes Audit
-
-### Root `firestore.indexes.json`
-
-| Index # | Collection | Fields | Query Purpose | Status |
-|---------|------------|--------|---------------|--------|
-| 1 | `apps` | `userId` ASC, `createdAt` DESC | List user's apps sorted by date | ✅ Exists |
-| 2 | `builds` | `userId` ASC, `createdAt` DESC | List user's builds sorted by date | ✅ Exists |
-| 3 | `builds` | `userId` ASC, `appId` ASC, `createdAt` DESC | Filter builds by app | ✅ Exists |
-| 4 | `builds` | `userId` ASC, `channel` ASC, `createdAt` DESC | Filter builds by channel | ✅ Exists |
-| 5 | `builds` | `userId` ASC, `status` ASC, `createdAt` DESC | Filter builds by status | ✅ Exists |
-| 6 | `builds` | `appId` ASC, `channel` ASC, `status` ASC, `createdAt` DESC | Complex build filtering | ✅ Exists |
-| 7 | `analytics` | `userId` ASC, `timestamp` DESC | User analytics history | ✅ Exists |
-
-### Website `firestore.indexes.json`
-
-Contains same indexes as root (synchronized).
-
-### Example App Firebase Backend `example-apps/firebase-backend/firestore.indexes.json`
-
-| Index # | Collection | Fields | Query Purpose | Status |
-|---------|------------|--------|---------------|--------|
-| 1 | `bundles` | `channel` ASC, `version` DESC, `createdAt` DESC | Get latest bundle by channel | ✅ Exists |
-| 2 | `updateLogs` | `appId` ASC, `timestamp` DESC | App update history | ✅ Exists |
-| 3 | `analytics` | `eventName` ASC, `timestamp` DESC | Analytics by event type | ✅ Exists |
-
----
-
-## Query-to-Index Mapping
-
-### Website Frontend Queries
-
-#### BuildsPage.tsx (Line 84-103)
-```typescript
-query(buildsRef,
-  where('userId', '==', user.uid),
-  orderBy('uploadedAt', 'desc'),
-  // Optional filters:
-  where('appId', '==', filters.appId),
-  where('channel', '==', filters.channel),
-  where('platform', '==', filters.platform),
-  where('status', '==', filters.status)
-)
-```
-**Index Required:** Multiple composite indexes depending on filter combination
-**Index Status:** ✅ Covered by indexes 2-6
-
-#### UploadPage.tsx (Line 49-64)
-```typescript
-// Apps query
-query(appsRef, where('userId', '==', user.uid))
-
-// Builds query
-query(buildsRef,
-  where('userId', '==', user.uid),
-  where('uploadedBy', '==', user.uid)
-)
-```
-**Index Required:** Basic userId filter (auto-indexed), uploadedBy needs single-field index
-**Index Status:** ✅ Auto-indexed single field queries
-
-#### ConfigPage.tsx (Line 30-32)
-```typescript
-query(appsRef, where('userId', '==', user.uid))
-```
-**Index Required:** Single field userId (auto-indexed)
-**Index Status:** ✅ Auto-indexed
-
-#### AnalyticsPage.tsx (Line 101-103)
-```typescript
-query(appsRef, where('userId', '==', user.uid))
-```
-**Index Required:** Single field userId (auto-indexed)
-**Index Status:** ✅ Auto-indexed
-
-#### GoogleDrivePage.tsx (Line 42-43)
-```typescript
-doc(db, 'users', user.uid)
-doc(db, 'drive_tokens', userId)
-```
-**Index Required:** None (document reads by ID)
-**Index Status:** ✅ N/A
-
-#### SettingsPage.tsx (Line 70-71)
-```typescript
-doc(db, 'users', user.uid)
-```
-**Index Required:** None (document read by ID)
-**Index Status:** ✅ N/A
-
-#### RolloutsStore.ts (Line 63)
-```typescript
-query(manifestsRef) // All manifests
-```
-**Index Required:** None (collection scan)
-**Index Status:** ✅ N/A
-
-### Website Firebase Functions Queries
-
-#### apps.ts (Line 111-115)
-```typescript
-db.collection('apps')
-  .where('userId', '==', user.uid)
-  .orderBy('createdAt', 'desc')
-```
-**Index Required:** Composite: userId ASC, createdAt DESC
-**Index Status:** ✅ Index #1
-
-#### builds.ts (Line 173-176)
-```typescript
-db.collection('builds')
-  .where('userId', '==', user.uid)
-  .orderBy('createdAt', 'desc')
-  // With optional filters for appId, platform, channel
-```
-**Index Required:** Multiple composite indexes
-**Index Status:** ✅ Indexes #2-6
-
-#### users.ts (Line 129-137)
-```typescript
-// Apps for user
-db.collection('apps').where('userId', '==', user.uid)
-
-// Builds for user
-db.collection('builds').where('userId', '==', user.uid)
-```
-**Index Required:** Single field userId (auto-indexed)
-**Index Status:** ✅ Auto-indexed
-
----
-
-## Missing Indexes Analysis
-
-After thorough audit, **NO missing indexes** were identified. All queries are covered by:
-1. Auto-indexed single-field queries
-2. Document ID reads (no index needed)
-3. Composite indexes defined in `firestore.indexes.json`
-
----
-
-## Security Recommendations Implemented
-
-1. ✅ All collections have owner-only access rules
-2. ✅ Analytics is write-only from client (prevents data exfiltration)
-3. ✅ Drive tokens stored in separate collection with owner-only access
-4. ✅ Default deny rule prevents unauthorized collection access
-5. ✅ Server-side validation in Firebase Functions
-
----
-
-## Deployment Commands
-
-```bash
-# Deploy Firestore indexes
-firebase deploy --only firestore:indexes
-
-# Deploy Firestore rules
-firebase deploy --only firestore:rules
-
-# Deploy both
-firebase deploy --only firestore
-```
-
----
-
-## Verification Checklist
-
-- [x] All queries mapped to indexes
-- [x] Security rules reviewed
-- [x] Owner checks verified for all collections
-- [x] No missing composite indexes
-- [x] Index files synchronized between root and website
-- [x] Example app has separate indexes for its collections
-
----
-
-## Last Verification Date
-
-**2026-01-16** - Full audit complete, all indexes verified

package/docs/examples/firebase-backend-example.md

@@ -1,27 +0,0 @@
-# Firebase Backend Example
-
-This example describes a serverless backend approach using Firebase services for manifests and bundle delivery.
-
-## What It Covers
-
-- Firestore-backed manifest strategy
-- Cloud Functions integration pattern
-- Firebase-centric deployment approach
-
-## Recommended Setup Flow
-
-1. Start with baseline architecture docs:
-   https://nativeupdate.aoneahsan.com/docs/server-requirements
-2. Review backend template guidance:
-   https://nativeupdate.aoneahsan.com/docs/guides/BACKEND_TEMPLATES_GUIDE
-3. Apply rollout and channel strategies:
-   https://nativeupdate.aoneahsan.com/docs/guides/channel-management
-
-## Related Docs
-
-- Dashboard Guide:
-  https://nativeupdate.aoneahsan.com/docs/guides/dashboard-guide
-- End-to-End Workflow:
-  https://nativeupdate.aoneahsan.com/docs/guides/end-to-end-workflow
-- Security Best Practices:
-  https://nativeupdate.aoneahsan.com/docs/guides/security-best-practices

package/docs/features/laravel-nova-backend/credentials.ignore.md

@@ -1,34 +0,0 @@
-# Laravel Nova Credentials (GITIGNORED)
-
-**File Pattern:** `*.ignore.*` - This file is excluded from git
-
----
-
-## Nova License
-
-| Field | Value |
-|-------|-------|
-| Email | Sajawal.developer@gmail.com |
-| Key | koFe33Gb0rhbseLFlcUj4IGM0gKlLeWKGvQ64BxU4biZh4H4P6 |
-
----
-
-## Usage
-
-When setting up Laravel project:
-
-```bash
-# Add to composer.json
-composer config http-basic.nova.laravel.com Sajawal.developer@gmail.com koFe33Gb0rhbseLFlcUj4IGM0gKlLeWKGvQ64BxU4biZh4H4P6
-
-# Or set environment variables
-export NOVA_LICENSE_EMAIL="Sajawal.developer@gmail.com"
-export NOVA_LICENSE_KEY="koFe33Gb0rhbseLFlcUj4IGM0gKlLeWKGvQ64BxU4biZh4H4P6"
-
-# Then install Nova
-composer require laravel/nova
-```
-
----
-
-**Saved:** 2026-03-28

package/docs/guides/no-cost-backend-implementation-plan.md

@@ -1,77 +0,0 @@
-# No-Cost Backend Implementation Plan
-
-This document is the concrete production plan for the `website` sub-project using a no-cost backend built from browser code, Firestore, and Google Drive.
-
-## Architecture
-
-- Dashboard: `website`
-- Metadata backend: Firestore
-- Bundle storage: user-owned Google Drive
-- App manifest read path: `apiKeys/{apiKey}/manifests/{channel}`
-- Compatibility read path: `manifests/{appId}_{channel}`
-- Human discovery endpoints: `/sitemap`, `/feed`
-- Machine discovery endpoints: `/sitemap.xml`, `/feed.xml`
-
-## Publish Flow
-
-1. User signs into the website dashboard.
-2. User connects Google Drive.
-3. User uploads a ZIP bundle from the dashboard.
-4. The website computes bundle checksum and manifest metadata in-browser.
-5. The website uploads the ZIP and generated manifest JSON to Google Drive.
-6. The website writes build history to Firestore.
-7. The website updates both manifest documents:
-   - `apiKeys/{apiKey}/manifests/{channel}`
-   - `manifests/{appId}_{channel}`
-8. Apps configured with `backendType: 'firestore'` read the latest manifest and download the published ZIP from Google Drive.
-
-## Firestore Collections
-
-- `apps/{appId}`
-  - dashboard-owned app registry and channel settings
-- `builds/{buildId}`
-  - uploaded build history, Drive URLs, release notes, checksums
-- `apiKeys/{apiKey}`
-  - secret lookup key metadata for manifest access
-- `apiKeys/{apiKey}/manifests/{channel}`
-  - primary manifest document for app update checks
-- `manifests/{appId}_{channel}`
-  - compatibility manifest document for existing readers
-
-## Security Model
-
-- Firestore rules allow public read only for manifest documents that apps need.
-- App, build, and API key documents stay owner-restricted.
-- Browser code does not hold server secrets.
-- Google Drive is used because the asset owner controls storage without paid compute.
-
-## Website Responsibilities
-
-- Keep dashboard configuration examples aligned with Firestore backend usage.
-- Keep upload flow routed through `uploadBundle()`.
-- Keep footer links to `/sitemap` and `/feed`.
-- Keep `scripts/generate-sitemap.mjs` current whenever routes or public content change.
-
-## Package Responsibilities
-
-- Support Firestore manifest reads through `backendType: 'firestore'`.
-- Accept `firestore.projectId` and optional `firestore.apiKey` in public config types.
-- Preserve HTTP backend support for users who self-host.
-
-## When A Separate Backend Is Justified
-
-Only add Laravel or another backend if one of these becomes mandatory:
-
-- server-held private signing keys
-- private asset proxy/download authorization
-- scheduled rollout jobs or cleanup tasks
-- heavy processing such as delta generation outside the browser
-
-## Production Checklist
-
-- Dashboard can connect Google Drive
-- ZIP publish updates Firestore manifest documents
-- App config snippets use `backendType: 'firestore'`
-- `/sitemap`, `/sitemap.xml`, `/feed`, and `/feed.xml` build successfully
-- Firestore rules are deployed
-- Google OAuth and Firebase environment variables are configured