Compare commits
30 Commits
trent-twea
...
new-storag
| Author | SHA1 | Date | |
|---|---|---|---|
| 61f28f9add | |||
|
|
574520d9b3 | ||
|
|
28e848e386 | ||
|
|
55f56174a5 | ||
|
|
30fb3aee8e | ||
| e254837951 | |||
| 8417cad2f3 | |||
| 0f56b659c1 | |||
| a8bfcb720a | |||
| c23e30c431 | |||
| 1129a13e20 | |||
| 5b6c59c232 | |||
| 295a2d9f63 | |||
|
|
6e14ccdbbc | ||
|
|
d636b21744 | ||
| 37b7c4ed36 | |||
|
|
f7728aadf0 | ||
|
|
ce34257ba1 | ||
|
|
190c972f57 | ||
|
|
831df4b253 | ||
|
|
55176ed5db | ||
|
|
b491262bef | ||
|
|
a1c18458e7 | ||
|
|
995af4e576 | ||
|
|
8ac728d488 | ||
|
|
913f11b66c | ||
|
|
79882715d8 | ||
| 22978a1eda | |||
| 79b2218129 | |||
| 52685702c1 |
267
.cursor/rules/wa-sqlite.mdc
Normal file
267
.cursor/rules/wa-sqlite.mdc
Normal file
@@ -0,0 +1,267 @@
|
||||
---
|
||||
description:
|
||||
globs:
|
||||
alwaysApply: true
|
||||
---
|
||||
# wa-sqlite Usage Guide
|
||||
|
||||
## Table of Contents
|
||||
- [1. Overview](#1-overview)
|
||||
- [2. Installation](#2-installation)
|
||||
- [3. Basic Setup](#3-basic-setup)
|
||||
- [3.1 Import and Initialize](#31-import-and-initialize)
|
||||
- [3.2 Basic Database Operations](#32-basic-database-operations)
|
||||
- [4. Virtual File Systems (VFS)](#4-virtual-file-systems-vfs)
|
||||
- [4.1 Available VFS Options](#41-available-vfs-options)
|
||||
- [4.2 Using a VFS](#42-using-a-vfs)
|
||||
- [5. Best Practices](#5-best-practices)
|
||||
- [5.1 Error Handling](#51-error-handling)
|
||||
- [5.2 Transaction Management](#52-transaction-management)
|
||||
- [5.3 Prepared Statements](#53-prepared-statements)
|
||||
- [6. Performance Considerations](#6-performance-considerations)
|
||||
- [7. Common Issues and Solutions](#7-common-issues-and-solutions)
|
||||
- [8. TypeScript Support](#8-typescript-support)
|
||||
|
||||
## 1. Overview
|
||||
wa-sqlite is a WebAssembly build of SQLite that enables SQLite database operations in web browsers and JavaScript environments. It provides both synchronous and asynchronous builds, with support for custom virtual file systems (VFS) for persistent storage.
|
||||
|
||||
## 2. Installation
|
||||
```bash
|
||||
npm install wa-sqlite
|
||||
# or
|
||||
yarn add wa-sqlite
|
||||
```
|
||||
|
||||
## 3. Basic Setup
|
||||
|
||||
### 3.1 Import and Initialize
|
||||
```javascript
|
||||
// Choose one of these imports based on your needs:
|
||||
// - wa-sqlite.mjs: Synchronous build
|
||||
// - wa-sqlite-async.mjs: Asynchronous build (required for async VFS)
|
||||
// - wa-sqlite-jspi.mjs: JSPI-based async build (experimental, Chromium only)
|
||||
import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs';
|
||||
import * as SQLite from 'wa-sqlite';
|
||||
|
||||
async function initDatabase() {
|
||||
// Initialize SQLite module
|
||||
const module = await SQLiteESMFactory();
|
||||
const sqlite3 = SQLite.Factory(module);
|
||||
|
||||
// Open database (returns a Promise)
|
||||
const db = await sqlite3.open_v2('myDatabase');
|
||||
return { sqlite3, db };
|
||||
}
|
||||
```
|
||||
|
||||
### 3.2 Basic Database Operations
|
||||
```javascript
|
||||
async function basicOperations() {
|
||||
const { sqlite3, db } = await initDatabase();
|
||||
|
||||
try {
|
||||
// Create a table
|
||||
await sqlite3.exec(db, `
|
||||
CREATE TABLE IF NOT EXISTS users (
|
||||
id INTEGER PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
email TEXT UNIQUE
|
||||
)
|
||||
`);
|
||||
|
||||
// Insert data
|
||||
await sqlite3.exec(db, `
|
||||
INSERT INTO users (name, email)
|
||||
VALUES ('John Doe', 'john@example.com')
|
||||
`);
|
||||
|
||||
// Query data
|
||||
const results = [];
|
||||
await sqlite3.exec(db, 'SELECT * FROM users', (row, columns) => {
|
||||
results.push({ row, columns });
|
||||
});
|
||||
|
||||
return results;
|
||||
} finally {
|
||||
// Always close the database when done
|
||||
await sqlite3.close(db);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 4. Virtual File Systems (VFS)
|
||||
|
||||
### 4.1 Available VFS Options
|
||||
wa-sqlite provides several VFS implementations for persistent storage:
|
||||
|
||||
1. **IDBBatchAtomicVFS** (Recommended for general use)
|
||||
- Uses IndexedDB with batch atomic writes
|
||||
- Works in all contexts (Window, Worker, Service Worker)
|
||||
- Supports WAL mode
|
||||
- Best performance with `PRAGMA synchronous=normal`
|
||||
|
||||
2. **IDBMirrorVFS**
|
||||
- Keeps files in memory, persists to IndexedDB
|
||||
- Works in all contexts
|
||||
- Good for smaller databases
|
||||
|
||||
3. **OPFS-based VFS** (Origin Private File System)
|
||||
- Various implementations available:
|
||||
- AccessHandlePoolVFS
|
||||
- OPFSAdaptiveVFS
|
||||
- OPFSCoopSyncVFS
|
||||
- OPFSPermutedVFS
|
||||
- Better performance but limited to Worker contexts
|
||||
|
||||
### 4.2 Using a VFS
|
||||
```javascript
|
||||
import { IDBBatchAtomicVFS } from 'wa-sqlite/src/examples/IDBBatchAtomicVFS.js';
|
||||
import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite-async.mjs';
|
||||
import * as SQLite from 'wa-sqlite';
|
||||
|
||||
async function initDatabaseWithVFS() {
|
||||
const module = await SQLiteESMFactory();
|
||||
const sqlite3 = SQLite.Factory(module);
|
||||
|
||||
// Register VFS
|
||||
const vfs = await IDBBatchAtomicVFS.create('myApp', module);
|
||||
sqlite3.vfs_register(vfs, true);
|
||||
|
||||
// Open database with VFS
|
||||
const db = await sqlite3.open_v2('myDatabase');
|
||||
|
||||
// Configure for better performance
|
||||
await sqlite3.exec(db, 'PRAGMA synchronous = normal');
|
||||
await sqlite3.exec(db, 'PRAGMA journal_mode = WAL');
|
||||
|
||||
return { sqlite3, db };
|
||||
}
|
||||
```
|
||||
|
||||
## 5. Best Practices
|
||||
|
||||
### 5.1 Error Handling
|
||||
```javascript
|
||||
async function safeDatabaseOperation() {
|
||||
const { sqlite3, db } = await initDatabase();
|
||||
|
||||
try {
|
||||
await sqlite3.exec(db, 'SELECT * FROM non_existent_table');
|
||||
} catch (error) {
|
||||
if (error.code === SQLite.SQLITE_ERROR) {
|
||||
console.error('SQL error:', error.message);
|
||||
} else {
|
||||
console.error('Database error:', error);
|
||||
}
|
||||
} finally {
|
||||
await sqlite3.close(db);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 5.2 Transaction Management
|
||||
```javascript
|
||||
async function transactionExample() {
|
||||
const { sqlite3, db } = await initDatabase();
|
||||
|
||||
try {
|
||||
await sqlite3.exec(db, 'BEGIN TRANSACTION');
|
||||
|
||||
// Perform multiple operations
|
||||
await sqlite3.exec(db, 'INSERT INTO users (name) VALUES (?)', ['Alice']);
|
||||
await sqlite3.exec(db, 'INSERT INTO users (name) VALUES (?)', ['Bob']);
|
||||
|
||||
await sqlite3.exec(db, 'COMMIT');
|
||||
} catch (error) {
|
||||
await sqlite3.exec(db, 'ROLLBACK');
|
||||
throw error;
|
||||
} finally {
|
||||
await sqlite3.close(db);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 5.3 Prepared Statements
|
||||
```javascript
|
||||
async function preparedStatementExample() {
|
||||
const { sqlite3, db } = await initDatabase();
|
||||
|
||||
try {
|
||||
// Prepare statement
|
||||
const stmt = await sqlite3.prepare(db, 'SELECT * FROM users WHERE id = ?');
|
||||
|
||||
// Execute with different parameters
|
||||
await sqlite3.bind(stmt, 1, 1);
|
||||
while (await sqlite3.step(stmt) === SQLite.SQLITE_ROW) {
|
||||
const row = sqlite3.row(stmt);
|
||||
console.log(row);
|
||||
}
|
||||
|
||||
// Reset and reuse
|
||||
await sqlite3.reset(stmt);
|
||||
await sqlite3.bind(stmt, 1, 2);
|
||||
// ... execute again
|
||||
|
||||
await sqlite3.finalize(stmt);
|
||||
} finally {
|
||||
await sqlite3.close(db);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 6. Performance Considerations
|
||||
|
||||
1. **VFS Selection**
|
||||
- Use IDBBatchAtomicVFS for general-purpose applications
|
||||
- Consider OPFS-based VFS for better performance in Worker contexts
|
||||
- Use MemoryVFS for temporary databases
|
||||
|
||||
2. **Configuration**
|
||||
- Set appropriate page size (default is usually fine)
|
||||
- Use WAL mode for better concurrency
|
||||
- Consider `PRAGMA synchronous=normal` for better performance
|
||||
- Adjust cache size based on your needs
|
||||
|
||||
3. **Concurrency**
|
||||
- Use transactions for multiple operations
|
||||
- Be aware of VFS-specific concurrency limitations
|
||||
- Consider using Web Workers for heavy database operations
|
||||
|
||||
## 7. Common Issues and Solutions
|
||||
|
||||
1. **Database Locking**
|
||||
- Use appropriate transaction isolation levels
|
||||
- Implement retry logic for busy errors
|
||||
- Consider using WAL mode
|
||||
|
||||
2. **Storage Limitations**
|
||||
- Be aware of browser storage quotas
|
||||
- Implement cleanup strategies
|
||||
- Monitor database size
|
||||
|
||||
3. **Cross-Context Access**
|
||||
- Use appropriate VFS for your context
|
||||
- Consider message passing for cross-context communication
|
||||
- Be aware of storage access limitations
|
||||
|
||||
## 8. TypeScript Support
|
||||
wa-sqlite includes TypeScript definitions. The main types are:
|
||||
|
||||
```typescript
|
||||
type SQLiteCompatibleType = number | string | Uint8Array | Array<number> | bigint | null;
|
||||
|
||||
interface SQLiteAPI {
|
||||
open_v2(filename: string, flags?: number, zVfs?: string): Promise<number>;
|
||||
exec(db: number, sql: string, callback?: (row: any[], columns: string[]) => void): Promise<number>;
|
||||
close(db: number): Promise<number>;
|
||||
// ... other methods
|
||||
}
|
||||
```
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Official GitHub Repository](https://github.com/rhashimoto/wa-sqlite)
|
||||
- [Online Demo](https://rhashimoto.github.io/wa-sqlite/demo/)
|
||||
- [API Reference](https://rhashimoto.github.io/wa-sqlite/docs/)
|
||||
- [FAQ](https://github.com/rhashimoto/wa-sqlite/issues?q=is%3Aissue+label%3Afaq+)
|
||||
- [Discussion Forums](https://github.com/rhashimoto/wa-sqlite/discussions)
|
||||
19
BUILDING.md
19
BUILDING.md
@@ -327,6 +327,7 @@ Prerequisites: macOS with Xcode installed
|
||||
1. Build the web assets:
|
||||
|
||||
```bash
|
||||
rm -rf dist
|
||||
npm run build:web
|
||||
npm run build:capacitor
|
||||
```
|
||||
@@ -346,7 +347,7 @@ Prerequisites: macOS with Xcode installed
|
||||
npx capacitor-assets generate --ios
|
||||
```
|
||||
|
||||
4. Bump the version to match Android
|
||||
4. Bump the version to match Android:
|
||||
|
||||
```
|
||||
cd ios/App
|
||||
@@ -395,10 +396,6 @@ Prerequisites: Android Studio with SDK installed
|
||||
rm -rf dist
|
||||
npm run build:web
|
||||
npm run build:capacitor
|
||||
cd android
|
||||
./gradlew clean
|
||||
./gradlew assembleDebug
|
||||
cd ..
|
||||
```
|
||||
|
||||
2. Update Android project with latest build:
|
||||
@@ -413,7 +410,7 @@ Prerequisites: Android Studio with SDK installed
|
||||
npx capacitor-assets generate --android
|
||||
```
|
||||
|
||||
4. Bump version to match iOS, in android/app/build.gradleq
|
||||
4. Bump version to match iOS: android/app/build.gradle
|
||||
|
||||
5. Open the project in Android Studio:
|
||||
|
||||
@@ -429,7 +426,7 @@ Prerequisites: Android Studio with SDK installed
|
||||
cd android
|
||||
./gradlew clean
|
||||
./gradlew build -Dlint.baselines.continue=true
|
||||
cd ..
|
||||
cd -
|
||||
npx cap run android
|
||||
```
|
||||
|
||||
@@ -453,9 +450,11 @@ Prerequisites: Android Studio with SDK installed
|
||||
|
||||
At play.google.com/console:
|
||||
|
||||
- Create new release, upload, hit Next.
|
||||
|
||||
- Save & send changes for review.
|
||||
- Go to the Testing Track (eg. Closed).
|
||||
- Click "Create new release".
|
||||
- Upload the `aab` file.
|
||||
- Hit "Next".
|
||||
- Save, go to "Publishing Overview" as prompted, and click "Send changes for review".
|
||||
|
||||
|
||||
## First-time Android Configuration for deep links
|
||||
|
||||
10
Dockerfile
10
Dockerfile
@@ -1,15 +1,9 @@
|
||||
# Build stage
|
||||
FROM node:22-alpine AS builder
|
||||
FROM node:22-alpine3.20 AS builder
|
||||
|
||||
# Install build dependencies
|
||||
|
||||
RUN apk add --no-cache \
|
||||
python3 \
|
||||
py3-pip \
|
||||
py3-setuptools \
|
||||
make \
|
||||
g++ \
|
||||
gcc
|
||||
RUN apk add --no-cache bash git python3 py3-pip py3-setuptools make g++ gcc
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
|
||||
@@ -12,6 +12,8 @@ See [project.task.yaml](project.task.yaml) for current priorities.
|
||||
|
||||
Quick start:
|
||||
|
||||
* For setup, we recommend [pkgx](https://pkgx.dev), which installs what you need (either automatically or with the `dev` command). Core dependencies are typescript & npm; when building for other platforms, you'll need other things such as those in the pkgx.yaml & BUILDING.md files.
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
|
||||
84
TASK_storage.md
Normal file
84
TASK_storage.md
Normal file
@@ -0,0 +1,84 @@
|
||||
|
||||
# What to do about storage for native apps?
|
||||
|
||||
|
||||
## Problem
|
||||
|
||||
We can't trust iOS IndexedDB to persist. I want to start delivering an app to people now, in preparation for presentations mid-June: Rotary on June 12 and Porcfest on June 17.
|
||||
|
||||
* Apple WebKit puts a [7-day cap on IndexedDB](https://webkit.org/blog/10218/full-third-party-cookie-blocking-and-more/).
|
||||
|
||||
* The web standards expose a `persist` method to mark memory as persistent, and [supposedly WebView supports it](https://developer.mozilla.org/en-US/docs/Web/API/StorageManager/persisted), but too many other things indicate it's not reliable. I've talked with [ChatGPT](https://chatgpt.com/share/68322f40-84c8-8007-b213-855f7962989a) & Venice & Claude (in Cursor); [this answer from Perplexity](https://www.perplexity.ai/search/which-platforms-prompt-the-use-HUQLqy4qQD2cRbkmO4CgHg) says that most platforms don't prompt and Safari doesn't support it; I don't know if that means WebKit as well.
|
||||
|
||||
* Capacitor says [not to trust it on iOS](https://capacitorjs.com/docs/v6/guides/storage).
|
||||
|
||||
Also, with sensitive data, the accounts info should be encrypted.
|
||||
|
||||
|
||||
# Options
|
||||
|
||||
* There is a community [SQLite plugin for Capacitor](https://github.com/capacitor-community/sqlite) with encryption by [SQLCipher](https://github.com/sqlcipher/sqlcipher).
|
||||
|
||||
* [This tutorial](https://jepiqueau.github.io/2023/09/05/Ionic7Vue-SQLite-CRUD-App.html#part-1---web---table-of-contents) shows how that plugin works for web as well as native.
|
||||
|
||||
* Capacitor abstracts [user preferences in an API](https://capacitorjs.com/docs/apis/preferences), which uses different underlying libraries on iOS & Android. Unfortunately, it won't do any filtering or searching, and is only meant for small amounts of data. (It could be used for settings and for identifiers, but contacts will grow and image blobs won't work.)
|
||||
|
||||
* There are hints that Capacitor offers another custom storage API but all I could find was that Preferences API.
|
||||
|
||||
* [Ionic Storage](https://ionic.io/docs/secure-storage) is an enterprise solution, which also supports encryption.
|
||||
|
||||
* Not an option yet: Dexie may support SQLite in [a future version](https://dexie.org/roadmap/dexie5.0).
|
||||
|
||||
|
||||
|
||||
# Current Plan
|
||||
|
||||
* Implement SQLite for Capacitor & web, with encryption. That will allow us to test quickly and keep the same interface for native & web, but we don't deal with migrations for current web users.
|
||||
|
||||
* After that is delivered, write a migration for current web users from IndexedDB to SQLite.
|
||||
|
||||
|
||||
|
||||
# Current method calls
|
||||
|
||||
... which is not 100% complete because the AI that generated thus claimed no usage of 'temp' DB.
|
||||
|
||||
### Secret Database (secretDB) - Used for storing the encryption key
|
||||
|
||||
secretDB.open() - Opens the database
|
||||
secretDB.secret.get(MASTER_SECRET_KEY) - Retrieves the secret key
|
||||
secretDB.secret.add({ id: MASTER_SECRET_KEY, secret }) - Adds a new secret key
|
||||
|
||||
### Accounts Database (accountsDB) - Used for storing sensitive account information
|
||||
|
||||
accountsDB.open() - Opens the database
|
||||
accountsDB.accounts.count() - Counts number of accounts
|
||||
accountsDB.accounts.toArray() - Gets all accounts
|
||||
accountsDB.accounts.where("did").equals(did).first() - Gets a specific account by DID
|
||||
accountsDB.accounts.add(account) - Adds a new account
|
||||
|
||||
### Non-sensitive Database (db) - Used for settings, contacts, logs, and temp data
|
||||
|
||||
Settings operations:
|
||||
export all settings (Dexie format)
|
||||
db.settings.get(MASTER_SETTINGS_KEY) - Gets default settings
|
||||
db.settings.where("accountDid").equals(did).first() - Gets account-specific settings
|
||||
db.settings.where("accountDid").equals(did).modify(settingsChanges) - Updates account settings
|
||||
db.settings.add(settingsChanges) - Adds new settings
|
||||
db.settings.count() - Counts number of settings
|
||||
db.settings.update(key, changes) - Updates settings
|
||||
|
||||
Contacts operations:
|
||||
export all contacts (Dexie format)
|
||||
db.contacts.toArray() - Gets all contacts
|
||||
db.contacts.add(contact) - Adds a new contact
|
||||
db.contacts.update(did, contactData) - Updates a contact
|
||||
db.contacts.delete(did) - Deletes a contact
|
||||
db.contacts.where("did").equals(did).first() - Gets a specific contact by DID
|
||||
|
||||
Logs operations:
|
||||
db.logs.get(todayKey) - Gets logs for a specific day
|
||||
db.logs.update(todayKey, { message: fullMessage }) - Updates logs
|
||||
db.logs.clear() - Clears all logs
|
||||
|
||||
|
||||
@@ -31,8 +31,8 @@ android {
|
||||
applicationId "app.timesafari.app"
|
||||
minSdkVersion rootProject.ext.minSdkVersion
|
||||
targetSdkVersion rootProject.ext.targetSdkVersion
|
||||
versionCode 10
|
||||
versionName "0.4.4"
|
||||
versionCode 18
|
||||
versionName "0.4.7"
|
||||
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
|
||||
aaptOptions {
|
||||
// Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.
|
||||
|
||||
389
docs/dexie-to-sqlite-mapping.md
Normal file
389
docs/dexie-to-sqlite-mapping.md
Normal file
@@ -0,0 +1,389 @@
|
||||
# Dexie to SQLite Mapping Guide
|
||||
|
||||
## Schema Mapping
|
||||
|
||||
### Current Dexie Schema
|
||||
```typescript
|
||||
// Current Dexie schema
|
||||
const db = new Dexie('TimeSafariDB');
|
||||
|
||||
db.version(1).stores({
|
||||
accounts: 'did, publicKeyHex, createdAt, updatedAt',
|
||||
settings: 'key, value, updatedAt',
|
||||
contacts: 'id, did, name, createdAt, updatedAt'
|
||||
});
|
||||
```
|
||||
|
||||
### New SQLite Schema
|
||||
```sql
|
||||
-- New SQLite schema
|
||||
CREATE TABLE accounts (
|
||||
did TEXT PRIMARY KEY,
|
||||
public_key_hex TEXT NOT NULL,
|
||||
created_at INTEGER NOT NULL,
|
||||
updated_at INTEGER NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE settings (
|
||||
key TEXT PRIMARY KEY,
|
||||
value TEXT NOT NULL,
|
||||
updated_at INTEGER NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE contacts (
|
||||
id TEXT PRIMARY KEY,
|
||||
did TEXT NOT NULL,
|
||||
name TEXT,
|
||||
created_at INTEGER NOT NULL,
|
||||
updated_at INTEGER NOT NULL,
|
||||
FOREIGN KEY (did) REFERENCES accounts(did)
|
||||
);
|
||||
|
||||
-- Indexes for performance
|
||||
CREATE INDEX idx_accounts_created_at ON accounts(created_at);
|
||||
CREATE INDEX idx_contacts_did ON contacts(did);
|
||||
CREATE INDEX idx_settings_updated_at ON settings(updated_at);
|
||||
```
|
||||
|
||||
## Query Mapping
|
||||
|
||||
### 1. Account Operations
|
||||
|
||||
#### Get Account by DID
|
||||
```typescript
|
||||
// Dexie
|
||||
const account = await db.accounts.get(did);
|
||||
|
||||
// SQLite
|
||||
const account = await db.selectOne(`
|
||||
SELECT * FROM accounts WHERE did = ?
|
||||
`, [did]);
|
||||
```
|
||||
|
||||
#### Get All Accounts
|
||||
```typescript
|
||||
// Dexie
|
||||
const accounts = await db.accounts.toArray();
|
||||
|
||||
// SQLite
|
||||
const accounts = await db.selectAll(`
|
||||
SELECT * FROM accounts ORDER BY created_at DESC
|
||||
`);
|
||||
```
|
||||
|
||||
#### Add Account
|
||||
```typescript
|
||||
// Dexie
|
||||
await db.accounts.add({
|
||||
did,
|
||||
publicKeyHex,
|
||||
createdAt: Date.now(),
|
||||
updatedAt: Date.now()
|
||||
});
|
||||
|
||||
// SQLite
|
||||
await db.execute(`
|
||||
INSERT INTO accounts (did, public_key_hex, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, [did, publicKeyHex, Date.now(), Date.now()]);
|
||||
```
|
||||
|
||||
#### Update Account
|
||||
```typescript
|
||||
// Dexie
|
||||
await db.accounts.update(did, {
|
||||
publicKeyHex,
|
||||
updatedAt: Date.now()
|
||||
});
|
||||
|
||||
// SQLite
|
||||
await db.execute(`
|
||||
UPDATE accounts
|
||||
SET public_key_hex = ?, updated_at = ?
|
||||
WHERE did = ?
|
||||
`, [publicKeyHex, Date.now(), did]);
|
||||
```
|
||||
|
||||
### 2. Settings Operations
|
||||
|
||||
#### Get Setting
|
||||
```typescript
|
||||
// Dexie
|
||||
const setting = await db.settings.get(key);
|
||||
|
||||
// SQLite
|
||||
const setting = await db.selectOne(`
|
||||
SELECT * FROM settings WHERE key = ?
|
||||
`, [key]);
|
||||
```
|
||||
|
||||
#### Set Setting
|
||||
```typescript
|
||||
// Dexie
|
||||
await db.settings.put({
|
||||
key,
|
||||
value,
|
||||
updatedAt: Date.now()
|
||||
});
|
||||
|
||||
// SQLite
|
||||
await db.execute(`
|
||||
INSERT INTO settings (key, value, updated_at)
|
||||
VALUES (?, ?, ?)
|
||||
ON CONFLICT(key) DO UPDATE SET
|
||||
value = excluded.value,
|
||||
updated_at = excluded.updated_at
|
||||
`, [key, value, Date.now()]);
|
||||
```
|
||||
|
||||
### 3. Contact Operations
|
||||
|
||||
#### Get Contacts by Account
|
||||
```typescript
|
||||
// Dexie
|
||||
const contacts = await db.contacts
|
||||
.where('did')
|
||||
.equals(accountDid)
|
||||
.toArray();
|
||||
|
||||
// SQLite
|
||||
const contacts = await db.selectAll(`
|
||||
SELECT * FROM contacts
|
||||
WHERE did = ?
|
||||
ORDER BY created_at DESC
|
||||
`, [accountDid]);
|
||||
```
|
||||
|
||||
#### Add Contact
|
||||
```typescript
|
||||
// Dexie
|
||||
await db.contacts.add({
|
||||
id: generateId(),
|
||||
did: accountDid,
|
||||
name,
|
||||
createdAt: Date.now(),
|
||||
updatedAt: Date.now()
|
||||
});
|
||||
|
||||
// SQLite
|
||||
await db.execute(`
|
||||
INSERT INTO contacts (id, did, name, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?)
|
||||
`, [generateId(), accountDid, name, Date.now(), Date.now()]);
|
||||
```
|
||||
|
||||
## Transaction Mapping
|
||||
|
||||
### Batch Operations
|
||||
```typescript
|
||||
// Dexie
|
||||
await db.transaction('rw', [db.accounts, db.contacts], async () => {
|
||||
await db.accounts.add(account);
|
||||
await db.contacts.bulkAdd(contacts);
|
||||
});
|
||||
|
||||
// SQLite
|
||||
await db.transaction(async (tx) => {
|
||||
await tx.execute(`
|
||||
INSERT INTO accounts (did, public_key_hex, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, [account.did, account.publicKeyHex, account.createdAt, account.updatedAt]);
|
||||
|
||||
for (const contact of contacts) {
|
||||
await tx.execute(`
|
||||
INSERT INTO contacts (id, did, name, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?)
|
||||
`, [contact.id, contact.did, contact.name, contact.createdAt, contact.updatedAt]);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## Migration Helper Functions
|
||||
|
||||
### 1. Data Export (Dexie to JSON)
|
||||
```typescript
|
||||
async function exportDexieData(): Promise<MigrationData> {
|
||||
const db = new Dexie('TimeSafariDB');
|
||||
|
||||
return {
|
||||
accounts: await db.accounts.toArray(),
|
||||
settings: await db.settings.toArray(),
|
||||
contacts: await db.contacts.toArray(),
|
||||
metadata: {
|
||||
version: '1.0.0',
|
||||
timestamp: Date.now(),
|
||||
dexieVersion: Dexie.version
|
||||
}
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Data Import (JSON to SQLite)
|
||||
```typescript
|
||||
async function importToSQLite(data: MigrationData): Promise<void> {
|
||||
const db = await getSQLiteConnection();
|
||||
|
||||
await db.transaction(async (tx) => {
|
||||
// Import accounts
|
||||
for (const account of data.accounts) {
|
||||
await tx.execute(`
|
||||
INSERT INTO accounts (did, public_key_hex, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, [account.did, account.publicKeyHex, account.createdAt, account.updatedAt]);
|
||||
}
|
||||
|
||||
// Import settings
|
||||
for (const setting of data.settings) {
|
||||
await tx.execute(`
|
||||
INSERT INTO settings (key, value, updated_at)
|
||||
VALUES (?, ?, ?)
|
||||
`, [setting.key, setting.value, setting.updatedAt]);
|
||||
}
|
||||
|
||||
// Import contacts
|
||||
for (const contact of data.contacts) {
|
||||
await tx.execute(`
|
||||
INSERT INTO contacts (id, did, name, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?)
|
||||
`, [contact.id, contact.did, contact.name, contact.createdAt, contact.updatedAt]);
|
||||
}
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Verification
|
||||
```typescript
|
||||
async function verifyMigration(dexieData: MigrationData): Promise<boolean> {
|
||||
const db = await getSQLiteConnection();
|
||||
|
||||
// Verify account count
|
||||
const accountCount = await db.selectValue(
|
||||
'SELECT COUNT(*) FROM accounts'
|
||||
);
|
||||
if (accountCount !== dexieData.accounts.length) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Verify settings count
|
||||
const settingsCount = await db.selectValue(
|
||||
'SELECT COUNT(*) FROM settings'
|
||||
);
|
||||
if (settingsCount !== dexieData.settings.length) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Verify contacts count
|
||||
const contactsCount = await db.selectValue(
|
||||
'SELECT COUNT(*) FROM contacts'
|
||||
);
|
||||
if (contactsCount !== dexieData.contacts.length) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Verify data integrity
|
||||
for (const account of dexieData.accounts) {
|
||||
const migratedAccount = await db.selectOne(
|
||||
'SELECT * FROM accounts WHERE did = ?',
|
||||
[account.did]
|
||||
);
|
||||
if (!migratedAccount ||
|
||||
migratedAccount.public_key_hex !== account.publicKeyHex) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
### 1. Indexing
|
||||
- Dexie automatically creates indexes based on the schema
|
||||
- SQLite requires explicit index creation
|
||||
- Added indexes for frequently queried fields
|
||||
|
||||
### 2. Batch Operations
|
||||
- Dexie has built-in bulk operations
|
||||
- SQLite uses transactions for batch operations
|
||||
- Consider chunking large datasets
|
||||
|
||||
### 3. Query Optimization
|
||||
- Dexie uses IndexedDB's native indexing
|
||||
- SQLite requires explicit query optimization
|
||||
- Use prepared statements for repeated queries
|
||||
|
||||
## Error Handling
|
||||
|
||||
### 1. Common Errors
|
||||
```typescript
|
||||
// Dexie errors
|
||||
try {
|
||||
await db.accounts.add(account);
|
||||
} catch (error) {
|
||||
if (error instanceof Dexie.ConstraintError) {
|
||||
// Handle duplicate key
|
||||
}
|
||||
}
|
||||
|
||||
// SQLite errors
|
||||
try {
|
||||
await db.execute(`
|
||||
INSERT INTO accounts (did, public_key_hex, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, [account.did, account.publicKeyHex, account.createdAt, account.updatedAt]);
|
||||
} catch (error) {
|
||||
if (error.code === 'SQLITE_CONSTRAINT') {
|
||||
// Handle duplicate key
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Transaction Recovery
|
||||
```typescript
|
||||
// Dexie transaction
|
||||
try {
|
||||
await db.transaction('rw', db.accounts, async () => {
|
||||
// Operations
|
||||
});
|
||||
} catch (error) {
|
||||
// Dexie automatically rolls back
|
||||
}
|
||||
|
||||
// SQLite transaction
|
||||
const db = await getSQLiteConnection();
|
||||
try {
|
||||
await db.transaction(async (tx) => {
|
||||
// Operations
|
||||
});
|
||||
} catch (error) {
|
||||
// SQLite automatically rolls back
|
||||
await db.execute('ROLLBACK');
|
||||
}
|
||||
```
|
||||
|
||||
## Migration Strategy
|
||||
|
||||
1. **Preparation**
|
||||
- Export all Dexie data
|
||||
- Verify data integrity
|
||||
- Create SQLite schema
|
||||
- Setup indexes
|
||||
|
||||
2. **Migration**
|
||||
- Import data in transactions
|
||||
- Verify each batch
|
||||
- Handle errors gracefully
|
||||
- Maintain backup
|
||||
|
||||
3. **Verification**
|
||||
- Compare record counts
|
||||
- Verify data integrity
|
||||
- Test common queries
|
||||
- Validate relationships
|
||||
|
||||
4. **Cleanup**
|
||||
- Remove Dexie database
|
||||
- Clear IndexedDB storage
|
||||
- Update application code
|
||||
- Remove old dependencies
|
||||
554
docs/migration-to-wa-sqlite.md
Normal file
554
docs/migration-to-wa-sqlite.md
Normal file
@@ -0,0 +1,554 @@
|
||||
# Migration Guide: Dexie to wa-sqlite
|
||||
|
||||
## Overview
|
||||
|
||||
This document outlines the migration process from Dexie.js to wa-sqlite for the TimeSafari app's storage implementation. The migration aims to provide a consistent SQLite-based storage solution across all platforms while maintaining data integrity and ensuring a smooth transition for users.
|
||||
|
||||
## Migration Goals
|
||||
|
||||
1. **Data Integrity**
|
||||
- Preserve all existing data
|
||||
- Maintain data relationships
|
||||
- Ensure data consistency
|
||||
|
||||
2. **Performance**
|
||||
- Improve query performance
|
||||
- Reduce storage overhead
|
||||
- Optimize for platform-specific features
|
||||
|
||||
3. **Security**
|
||||
- Maintain or improve encryption
|
||||
- Preserve access controls
|
||||
- Enhance data protection
|
||||
|
||||
4. **User Experience**
|
||||
- Zero data loss
|
||||
- Minimal downtime
|
||||
- Automatic migration where possible
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. **Backup Requirements**
|
||||
```typescript
|
||||
interface MigrationBackup {
|
||||
timestamp: number;
|
||||
accounts: Account[];
|
||||
settings: Setting[];
|
||||
contacts: Contact[];
|
||||
metadata: {
|
||||
version: string;
|
||||
platform: string;
|
||||
dexieVersion: string;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
2. **Storage Requirements**
|
||||
- Sufficient IndexedDB quota
|
||||
- Available disk space for SQLite
|
||||
- Backup storage space
|
||||
|
||||
3. **Platform Support**
|
||||
- Web: Modern browser with IndexedDB support
|
||||
- iOS: iOS 13+ with SQLite support
|
||||
- Android: Android 5+ with SQLite support
|
||||
- Electron: Latest version with SQLite support
|
||||
|
||||
## Migration Process
|
||||
|
||||
### 1. Preparation
|
||||
|
||||
```typescript
|
||||
// src/services/storage/migration/MigrationService.ts
|
||||
export class MigrationService {
|
||||
private static instance: MigrationService;
|
||||
private backup: MigrationBackup | null = null;
|
||||
|
||||
async prepare(): Promise<void> {
|
||||
try {
|
||||
// 1. Check prerequisites
|
||||
await this.checkPrerequisites();
|
||||
|
||||
// 2. Create backup
|
||||
this.backup = await this.createBackup();
|
||||
|
||||
// 3. Verify backup integrity
|
||||
await this.verifyBackup();
|
||||
|
||||
// 4. Initialize wa-sqlite
|
||||
await this.initializeWaSqlite();
|
||||
} catch (error) {
|
||||
throw new StorageError(
|
||||
'Migration preparation failed',
|
||||
StorageErrorCodes.MIGRATION_FAILED,
|
||||
error
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private async checkPrerequisites(): Promise<void> {
|
||||
// Check IndexedDB availability
|
||||
if (!window.indexedDB) {
|
||||
throw new StorageError(
|
||||
'IndexedDB not available',
|
||||
StorageErrorCodes.INITIALIZATION_FAILED
|
||||
);
|
||||
}
|
||||
|
||||
// Check storage quota
|
||||
const quota = await navigator.storage.estimate();
|
||||
if (quota.quota && quota.usage && quota.usage > quota.quota * 0.9) {
|
||||
throw new StorageError(
|
||||
'Insufficient storage space',
|
||||
StorageErrorCodes.STORAGE_FULL
|
||||
);
|
||||
}
|
||||
|
||||
// Check platform support
|
||||
const capabilities = await PlatformDetection.getCapabilities();
|
||||
if (!capabilities.hasFileSystem) {
|
||||
throw new StorageError(
|
||||
'Platform does not support required features',
|
||||
StorageErrorCodes.INITIALIZATION_FAILED
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private async createBackup(): Promise<MigrationBackup> {
|
||||
const dexieDB = new Dexie('TimeSafariDB');
|
||||
|
||||
return {
|
||||
timestamp: Date.now(),
|
||||
accounts: await dexieDB.accounts.toArray(),
|
||||
settings: await dexieDB.settings.toArray(),
|
||||
contacts: await dexieDB.contacts.toArray(),
|
||||
metadata: {
|
||||
version: '1.0.0',
|
||||
platform: await PlatformDetection.getPlatform(),
|
||||
dexieVersion: Dexie.version
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Data Migration
|
||||
|
||||
```typescript
|
||||
// src/services/storage/migration/DataMigration.ts
|
||||
export class DataMigration {
|
||||
async migrate(backup: MigrationBackup): Promise<void> {
|
||||
try {
|
||||
// 1. Create new database schema
|
||||
await this.createSchema();
|
||||
|
||||
// 2. Migrate accounts
|
||||
await this.migrateAccounts(backup.accounts);
|
||||
|
||||
// 3. Migrate settings
|
||||
await this.migrateSettings(backup.settings);
|
||||
|
||||
// 4. Migrate contacts
|
||||
await this.migrateContacts(backup.contacts);
|
||||
|
||||
// 5. Verify migration
|
||||
await this.verifyMigration(backup);
|
||||
} catch (error) {
|
||||
// 6. Handle failure
|
||||
await this.handleMigrationFailure(error, backup);
|
||||
}
|
||||
}
|
||||
|
||||
private async migrateAccounts(accounts: Account[]): Promise<void> {
|
||||
const db = await this.getWaSqliteConnection();
|
||||
|
||||
// Use transaction for atomicity
|
||||
await db.transaction(async (tx) => {
|
||||
for (const account of accounts) {
|
||||
await tx.execute(`
|
||||
INSERT INTO accounts (did, public_key_hex, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?)
|
||||
`, [
|
||||
account.did,
|
||||
account.publicKeyHex,
|
||||
account.createdAt,
|
||||
account.updatedAt
|
||||
]);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
private async verifyMigration(backup: MigrationBackup): Promise<void> {
|
||||
const db = await this.getWaSqliteConnection();
|
||||
|
||||
// Verify account count
|
||||
const accountCount = await db.selectValue(
|
||||
'SELECT COUNT(*) FROM accounts'
|
||||
);
|
||||
if (accountCount !== backup.accounts.length) {
|
||||
throw new StorageError(
|
||||
'Account count mismatch',
|
||||
StorageErrorCodes.VERIFICATION_FAILED
|
||||
);
|
||||
}
|
||||
|
||||
// Verify data integrity
|
||||
await this.verifyDataIntegrity(backup);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Rollback Strategy
|
||||
|
||||
```typescript
|
||||
// src/services/storage/migration/RollbackService.ts
|
||||
export class RollbackService {
|
||||
async rollback(backup: MigrationBackup): Promise<void> {
|
||||
try {
|
||||
// 1. Stop all database operations
|
||||
await this.stopDatabaseOperations();
|
||||
|
||||
// 2. Restore from backup
|
||||
await this.restoreFromBackup(backup);
|
||||
|
||||
// 3. Verify restoration
|
||||
await this.verifyRestoration(backup);
|
||||
|
||||
// 4. Clean up wa-sqlite
|
||||
await this.cleanupWaSqlite();
|
||||
} catch (error) {
|
||||
throw new StorageError(
|
||||
'Rollback failed',
|
||||
StorageErrorCodes.ROLLBACK_FAILED,
|
||||
error
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private async restoreFromBackup(backup: MigrationBackup): Promise<void> {
|
||||
const dexieDB = new Dexie('TimeSafariDB');
|
||||
|
||||
// Restore accounts
|
||||
await dexieDB.accounts.bulkPut(backup.accounts);
|
||||
|
||||
// Restore settings
|
||||
await dexieDB.settings.bulkPut(backup.settings);
|
||||
|
||||
// Restore contacts
|
||||
await dexieDB.contacts.bulkPut(backup.contacts);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Migration UI
|
||||
|
||||
```vue
|
||||
<!-- src/components/MigrationProgress.vue -->
|
||||
<template>
|
||||
<div class="migration-progress">
|
||||
<h2>Database Migration</h2>
|
||||
|
||||
<div class="progress-container">
|
||||
<div class="progress-bar" :style="{ width: `${progress}%` }" />
|
||||
<div class="progress-text">{{ progress }}%</div>
|
||||
</div>
|
||||
|
||||
<div class="status-message">{{ statusMessage }}</div>
|
||||
|
||||
<div v-if="error" class="error-message">
|
||||
{{ error }}
|
||||
<button @click="retryMigration">Retry</button>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { ref, onMounted } from 'vue';
|
||||
import { MigrationService } from '@/services/storage/migration/MigrationService';
|
||||
|
||||
const progress = ref(0);
|
||||
const statusMessage = ref('Preparing migration...');
|
||||
const error = ref<string | null>(null);
|
||||
|
||||
const migrationService = MigrationService.getInstance();
|
||||
|
||||
async function startMigration() {
|
||||
try {
|
||||
// 1. Preparation
|
||||
statusMessage.value = 'Creating backup...';
|
||||
await migrationService.prepare();
|
||||
progress.value = 20;
|
||||
|
||||
// 2. Data migration
|
||||
statusMessage.value = 'Migrating data...';
|
||||
await migrationService.migrate();
|
||||
progress.value = 80;
|
||||
|
||||
// 3. Verification
|
||||
statusMessage.value = 'Verifying migration...';
|
||||
await migrationService.verify();
|
||||
progress.value = 100;
|
||||
|
||||
statusMessage.value = 'Migration completed successfully!';
|
||||
} catch (err) {
|
||||
error.value = err instanceof Error ? err.message : 'Migration failed';
|
||||
statusMessage.value = 'Migration failed';
|
||||
}
|
||||
}
|
||||
|
||||
async function retryMigration() {
|
||||
error.value = null;
|
||||
progress.value = 0;
|
||||
await startMigration();
|
||||
}
|
||||
|
||||
onMounted(() => {
|
||||
startMigration();
|
||||
});
|
||||
</script>
|
||||
|
||||
<style scoped>
|
||||
.migration-progress {
|
||||
padding: 2rem;
|
||||
max-width: 600px;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
.progress-container {
|
||||
position: relative;
|
||||
height: 20px;
|
||||
background: #eee;
|
||||
border-radius: 10px;
|
||||
overflow: hidden;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
.progress-bar {
|
||||
position: absolute;
|
||||
height: 100%;
|
||||
background: #4CAF50;
|
||||
transition: width 0.3s ease;
|
||||
}
|
||||
|
||||
.progress-text {
|
||||
position: absolute;
|
||||
width: 100%;
|
||||
text-align: center;
|
||||
line-height: 20px;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
.status-message {
|
||||
text-align: center;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
.error-message {
|
||||
color: #f44336;
|
||||
text-align: center;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
button {
|
||||
margin-top: 1rem;
|
||||
padding: 0.5rem 1rem;
|
||||
background: #2196F3;
|
||||
color: white;
|
||||
border: none;
|
||||
border-radius: 4px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
button:hover {
|
||||
background: #1976D2;
|
||||
}
|
||||
</style>
|
||||
```
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
1. **Unit Tests**
|
||||
```typescript
|
||||
// src/services/storage/migration/__tests__/MigrationService.spec.ts
|
||||
describe('MigrationService', () => {
|
||||
it('should create valid backup', async () => {
|
||||
const service = MigrationService.getInstance();
|
||||
const backup = await service.createBackup();
|
||||
|
||||
expect(backup).toBeDefined();
|
||||
expect(backup.accounts).toBeInstanceOf(Array);
|
||||
expect(backup.settings).toBeInstanceOf(Array);
|
||||
expect(backup.contacts).toBeInstanceOf(Array);
|
||||
});
|
||||
|
||||
it('should migrate data correctly', async () => {
|
||||
const service = MigrationService.getInstance();
|
||||
const backup = await service.createBackup();
|
||||
|
||||
await service.migrate(backup);
|
||||
|
||||
// Verify migration
|
||||
const accounts = await service.getMigratedAccounts();
|
||||
expect(accounts).toHaveLength(backup.accounts.length);
|
||||
});
|
||||
|
||||
it('should handle rollback correctly', async () => {
|
||||
const service = MigrationService.getInstance();
|
||||
const backup = await service.createBackup();
|
||||
|
||||
// Simulate failed migration
|
||||
await service.migrate(backup);
|
||||
await service.simulateFailure();
|
||||
|
||||
// Perform rollback
|
||||
await service.rollback(backup);
|
||||
|
||||
// Verify rollback
|
||||
const accounts = await service.getOriginalAccounts();
|
||||
expect(accounts).toHaveLength(backup.accounts.length);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
2. **Integration Tests**
|
||||
```typescript
|
||||
// src/services/storage/migration/__tests__/integration/Migration.spec.ts
|
||||
describe('Migration Integration', () => {
|
||||
it('should handle concurrent access during migration', async () => {
|
||||
const service = MigrationService.getInstance();
|
||||
|
||||
// Start migration
|
||||
const migrationPromise = service.migrate();
|
||||
|
||||
// Simulate concurrent access
|
||||
const accessPromises = Array(5).fill(null).map(() =>
|
||||
service.getAccount('did:test:123')
|
||||
);
|
||||
|
||||
// Wait for all operations
|
||||
const [migrationResult, ...accessResults] = await Promise.allSettled([
|
||||
migrationPromise,
|
||||
...accessPromises
|
||||
]);
|
||||
|
||||
// Verify results
|
||||
expect(migrationResult.status).toBe('fulfilled');
|
||||
expect(accessResults.some(r => r.status === 'rejected')).toBe(true);
|
||||
});
|
||||
|
||||
it('should maintain data integrity during platform transition', async () => {
|
||||
const service = MigrationService.getInstance();
|
||||
|
||||
// Simulate platform change
|
||||
await service.simulatePlatformChange();
|
||||
|
||||
// Verify data
|
||||
const accounts = await service.getAllAccounts();
|
||||
const settings = await service.getAllSettings();
|
||||
const contacts = await service.getAllContacts();
|
||||
|
||||
expect(accounts).toBeDefined();
|
||||
expect(settings).toBeDefined();
|
||||
expect(contacts).toBeDefined();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
## Success Criteria
|
||||
|
||||
1. **Data Integrity**
|
||||
- [ ] All accounts migrated successfully
|
||||
- [ ] All settings preserved
|
||||
- [ ] All contacts transferred
|
||||
- [ ] No data corruption
|
||||
|
||||
2. **Performance**
|
||||
- [ ] Migration completes within acceptable time
|
||||
- [ ] No significant performance degradation
|
||||
- [ ] Efficient storage usage
|
||||
- [ ] Smooth user experience
|
||||
|
||||
3. **Security**
|
||||
- [ ] Encrypted data remains secure
|
||||
- [ ] Access controls maintained
|
||||
- [ ] No sensitive data exposure
|
||||
- [ ] Secure backup process
|
||||
|
||||
4. **User Experience**
|
||||
- [ ] Clear migration progress
|
||||
- [ ] Informative error messages
|
||||
- [ ] Automatic recovery from failures
|
||||
- [ ] No data loss
|
||||
|
||||
## Rollback Plan
|
||||
|
||||
1. **Automatic Rollback**
|
||||
- Triggered by migration failure
|
||||
- Restores from verified backup
|
||||
- Maintains data consistency
|
||||
- Logs rollback reason
|
||||
|
||||
2. **Manual Rollback**
|
||||
- Available through settings
|
||||
- Requires user confirmation
|
||||
- Preserves backup data
|
||||
- Provides rollback status
|
||||
|
||||
3. **Emergency Recovery**
|
||||
- Manual backup restoration
|
||||
- Database repair tools
|
||||
- Data recovery procedures
|
||||
- Support contact information
|
||||
|
||||
## Post-Migration
|
||||
|
||||
1. **Verification**
|
||||
- Data integrity checks
|
||||
- Performance monitoring
|
||||
- Error rate tracking
|
||||
- User feedback collection
|
||||
|
||||
2. **Cleanup**
|
||||
- Remove old database
|
||||
- Clear migration artifacts
|
||||
- Update application state
|
||||
- Archive backup data
|
||||
|
||||
3. **Monitoring**
|
||||
- Track migration success rate
|
||||
- Monitor performance metrics
|
||||
- Collect error reports
|
||||
- Gather user feedback
|
||||
|
||||
## Support
|
||||
|
||||
For assistance with migration:
|
||||
1. Check the troubleshooting guide
|
||||
2. Review error logs
|
||||
3. Contact support team
|
||||
4. Submit issue report
|
||||
|
||||
## Timeline
|
||||
|
||||
1. **Preparation Phase** (1 week)
|
||||
- Backup system implementation
|
||||
- Migration service development
|
||||
- Testing framework setup
|
||||
|
||||
2. **Testing Phase** (2 weeks)
|
||||
- Unit testing
|
||||
- Integration testing
|
||||
- Performance testing
|
||||
- Security testing
|
||||
|
||||
3. **Deployment Phase** (1 week)
|
||||
- Staged rollout
|
||||
- Monitoring
|
||||
- Support preparation
|
||||
- Documentation updates
|
||||
|
||||
4. **Post-Deployment** (2 weeks)
|
||||
- Monitoring
|
||||
- Bug fixes
|
||||
- Performance optimization
|
||||
- User feedback collection
|
||||
1310
docs/secure-storage-implementation.md
Normal file
1310
docs/secure-storage-implementation.md
Normal file
File diff suppressed because it is too large
Load Diff
307
docs/storage-implementation-checklist.md
Normal file
307
docs/storage-implementation-checklist.md
Normal file
@@ -0,0 +1,307 @@
|
||||
# Storage Implementation Checklist
|
||||
|
||||
## Core Services
|
||||
|
||||
### 1. Storage Service Layer
|
||||
- [ ] Create base `StorageService` interface
|
||||
- [ ] Define common methods for all platforms
|
||||
- [ ] Add platform-specific method signatures
|
||||
- [ ] Include error handling types
|
||||
- [ ] Add migration support methods
|
||||
|
||||
- [ ] Implement platform-specific services
|
||||
- [ ] `WebSQLiteService` (wa-sqlite)
|
||||
- [ ] Database initialization
|
||||
- [ ] VFS setup
|
||||
- [ ] Connection management
|
||||
- [ ] Query builder
|
||||
- [ ] `NativeSQLiteService` (iOS/Android)
|
||||
- [ ] SQLCipher integration
|
||||
- [ ] Native bridge setup
|
||||
- [ ] File system access
|
||||
- [ ] `ElectronSQLiteService`
|
||||
- [ ] Node SQLite integration
|
||||
- [ ] IPC communication
|
||||
- [ ] File system access
|
||||
|
||||
### 2. Migration Services
|
||||
- [ ] Implement `MigrationService`
|
||||
- [ ] Backup creation
|
||||
- [ ] Data verification
|
||||
- [ ] Rollback procedures
|
||||
- [ ] Progress tracking
|
||||
- [ ] Create `MigrationUI` components
|
||||
- [ ] Progress indicators
|
||||
- [ ] Error handling
|
||||
- [ ] User notifications
|
||||
- [ ] Manual triggers
|
||||
|
||||
### 3. Security Layer
|
||||
- [ ] Implement `EncryptionService`
|
||||
- [ ] Key management
|
||||
- [ ] Encryption/decryption
|
||||
- [ ] Secure storage
|
||||
- [ ] Add `BiometricService`
|
||||
- [ ] Platform detection
|
||||
- [ ] Authentication flow
|
||||
- [ ] Fallback mechanisms
|
||||
|
||||
## Platform-Specific Implementation
|
||||
|
||||
### Web Platform
|
||||
- [ ] Setup wa-sqlite
|
||||
- [ ] Install dependencies
|
||||
```json
|
||||
{
|
||||
"@wa-sqlite/sql.js": "^0.8.12",
|
||||
"@wa-sqlite/sql.js-httpvfs": "^0.8.12"
|
||||
}
|
||||
```
|
||||
(May not need httpvfs. Here's one recommended install method: `npm add github:rhashimoto/wa-sqlite`)
|
||||
- [ ] Configure VFS for IndexedDB (eg. IDBBatchAtomicVFS)
|
||||
- [ ] Setup worker threads
|
||||
- [ ] Implement connection pooling
|
||||
|
||||
- [ ] Update build configuration
|
||||
- [ ] Modify `vite.config.ts`
|
||||
- [ ] Add worker configuration
|
||||
- [ ] Update chunk splitting
|
||||
- [ ] Configure asset handling
|
||||
|
||||
- [ ] Implement IndexedDB fallback
|
||||
- [ ] Create fallback service
|
||||
- [ ] Add data synchronization
|
||||
- [ ] Handle quota exceeded
|
||||
|
||||
### iOS Platform
|
||||
- [ ] Setup SQLCipher
|
||||
- [ ] Install pod dependencies
|
||||
- [ ] Configure encryption
|
||||
- [ ] Setup keychain access
|
||||
- [ ] Implement secure storage
|
||||
|
||||
- [ ] Update Capacitor config
|
||||
- [ ] Modify `capacitor.config.ts`
|
||||
- [ ] Add iOS permissions
|
||||
- [ ] Configure backup
|
||||
- [ ] Setup app groups
|
||||
|
||||
### Android Platform
|
||||
- [ ] Setup SQLCipher
|
||||
- [ ] Add Gradle dependencies
|
||||
- [ ] Configure encryption
|
||||
- [ ] Setup keystore
|
||||
- [ ] Implement secure storage
|
||||
|
||||
- [ ] Update Capacitor config
|
||||
- [ ] Modify `capacitor.config.ts`
|
||||
- [ ] Add Android permissions
|
||||
- [ ] Configure backup
|
||||
- [ ] Setup file provider
|
||||
|
||||
### Electron Platform
|
||||
- [ ] Setup Node SQLite
|
||||
- [ ] Install dependencies
|
||||
- [ ] Configure IPC
|
||||
- [ ] Setup file system access
|
||||
- [ ] Implement secure storage
|
||||
|
||||
- [ ] Update Electron config
|
||||
- [ ] Modify `electron.config.ts`
|
||||
- [ ] Add security policies
|
||||
- [ ] Configure file access
|
||||
- [ ] Setup auto-updates
|
||||
|
||||
## Data Models and Types
|
||||
|
||||
### 1. Database Schema
|
||||
- [ ] Define tables
|
||||
```sql
|
||||
-- Accounts table
|
||||
CREATE TABLE accounts (
|
||||
did TEXT PRIMARY KEY,
|
||||
public_key_hex TEXT NOT NULL,
|
||||
created_at INTEGER NOT NULL,
|
||||
updated_at INTEGER NOT NULL
|
||||
);
|
||||
|
||||
-- Settings table
|
||||
CREATE TABLE settings (
|
||||
key TEXT PRIMARY KEY,
|
||||
value TEXT NOT NULL,
|
||||
updated_at INTEGER NOT NULL
|
||||
);
|
||||
|
||||
-- Contacts table
|
||||
CREATE TABLE contacts (
|
||||
id TEXT PRIMARY KEY,
|
||||
did TEXT NOT NULL,
|
||||
name TEXT,
|
||||
created_at INTEGER NOT NULL,
|
||||
updated_at INTEGER NOT NULL,
|
||||
FOREIGN KEY (did) REFERENCES accounts(did)
|
||||
);
|
||||
```
|
||||
|
||||
- [ ] Create indexes
|
||||
- [ ] Define constraints
|
||||
- [ ] Add triggers
|
||||
- [ ] Setup migrations
|
||||
|
||||
### 2. Type Definitions
|
||||
- [ ] Create interfaces
|
||||
```typescript
|
||||
interface Account {
|
||||
did: string;
|
||||
publicKeyHex: string;
|
||||
createdAt: number;
|
||||
updatedAt: number;
|
||||
}
|
||||
|
||||
interface Setting {
|
||||
key: string;
|
||||
value: string;
|
||||
updatedAt: number;
|
||||
}
|
||||
|
||||
interface Contact {
|
||||
id: string;
|
||||
did: string;
|
||||
name?: string;
|
||||
createdAt: number;
|
||||
updatedAt: number;
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] Add validation
|
||||
- [ ] Create DTOs
|
||||
- [ ] Define enums
|
||||
- [ ] Add type guards
|
||||
|
||||
## UI Components
|
||||
|
||||
### 1. Migration UI
|
||||
- [ ] Create components
|
||||
- [ ] `MigrationProgress.vue`
|
||||
- [ ] `MigrationError.vue`
|
||||
- [ ] `MigrationSettings.vue`
|
||||
- [ ] `MigrationStatus.vue`
|
||||
|
||||
### 2. Settings UI
|
||||
- [ ] Update components
|
||||
- [ ] Add storage settings
|
||||
- [ ] Add migration controls
|
||||
- [ ] Add backup options
|
||||
- [ ] Add security settings
|
||||
|
||||
### 3. Error Handling UI
|
||||
- [ ] Create components
|
||||
- [ ] `StorageError.vue`
|
||||
- [ ] `QuotaExceeded.vue`
|
||||
- [ ] `MigrationFailed.vue`
|
||||
- [ ] `RecoveryOptions.vue`
|
||||
|
||||
## Testing
|
||||
|
||||
### 1. Unit Tests
|
||||
- [ ] Test services
|
||||
- [ ] Storage service tests
|
||||
- [ ] Migration service tests
|
||||
- [ ] Security service tests
|
||||
- [ ] Platform detection tests
|
||||
|
||||
### 2. Integration Tests
|
||||
- [ ] Test migrations
|
||||
- [ ] Web platform tests
|
||||
- [ ] iOS platform tests
|
||||
- [ ] Android platform tests
|
||||
- [ ] Electron platform tests
|
||||
|
||||
### 3. E2E Tests
|
||||
- [ ] Test workflows
|
||||
- [ ] Account management
|
||||
- [ ] Settings management
|
||||
- [ ] Contact management
|
||||
- [ ] Migration process
|
||||
|
||||
## Documentation
|
||||
|
||||
### 1. Technical Documentation
|
||||
- [ ] Update architecture docs
|
||||
- [ ] Add API documentation
|
||||
- [ ] Create migration guides
|
||||
- [ ] Document security measures
|
||||
|
||||
### 2. User Documentation
|
||||
- [ ] Update user guides
|
||||
- [ ] Add troubleshooting guides
|
||||
- [ ] Create FAQ
|
||||
- [ ] Document new features
|
||||
|
||||
## Deployment
|
||||
|
||||
### 1. Build Process
|
||||
- [ ] Update build scripts
|
||||
- [ ] Add platform-specific builds
|
||||
- [ ] Configure CI/CD
|
||||
- [ ] Setup automated testing
|
||||
|
||||
### 2. Release Process
|
||||
- [ ] Create release checklist
|
||||
- [ ] Add version management
|
||||
- [ ] Setup rollback procedures
|
||||
- [ ] Configure monitoring
|
||||
|
||||
## Monitoring and Analytics
|
||||
|
||||
### 1. Error Tracking
|
||||
- [ ] Setup error logging
|
||||
- [ ] Add performance monitoring
|
||||
- [ ] Configure alerts
|
||||
- [ ] Create dashboards
|
||||
|
||||
### 2. Usage Analytics
|
||||
- [ ] Add storage metrics
|
||||
- [ ] Track migration success
|
||||
- [ ] Monitor performance
|
||||
- [ ] Collect user feedback
|
||||
|
||||
## Security Audit
|
||||
|
||||
### 1. Code Review
|
||||
- [ ] Review encryption
|
||||
- [ ] Check access controls
|
||||
- [ ] Verify data handling
|
||||
- [ ] Audit dependencies
|
||||
|
||||
### 2. Penetration Testing
|
||||
- [ ] Test data access
|
||||
- [ ] Verify encryption
|
||||
- [ ] Check authentication
|
||||
- [ ] Review permissions
|
||||
|
||||
## Success Criteria
|
||||
|
||||
### 1. Performance
|
||||
- [ ] Query response time < 100ms
|
||||
- [ ] Migration time < 5s per 1000 records
|
||||
- [ ] Storage overhead < 10%
|
||||
- [ ] Memory usage < 50MB
|
||||
|
||||
### 2. Reliability
|
||||
- [ ] 99.9% uptime
|
||||
- [ ] Zero data loss
|
||||
- [ ] Automatic recovery
|
||||
- [ ] Backup verification
|
||||
|
||||
### 3. Security
|
||||
- [ ] AES-256 encryption
|
||||
- [ ] Secure key storage
|
||||
- [ ] Access control
|
||||
- [ ] Audit logging
|
||||
|
||||
### 4. User Experience
|
||||
- [ ] Smooth migration
|
||||
- [ ] Clear error messages
|
||||
- [ ] Progress indicators
|
||||
- [ ] Recovery options
|
||||
@@ -3,7 +3,7 @@
|
||||
archiveVersion = 1;
|
||||
classes = {
|
||||
};
|
||||
objectVersion = 48;
|
||||
objectVersion = 54;
|
||||
objects = {
|
||||
|
||||
/* Begin PBXBuildFile section */
|
||||
@@ -106,6 +106,7 @@
|
||||
504EC3011FED79650016851F /* Frameworks */,
|
||||
504EC3021FED79650016851F /* Resources */,
|
||||
9592DBEFFC6D2A0C8D5DEB22 /* [CP] Embed Pods Frameworks */,
|
||||
012076E8FFE4BF260A79B034 /* Fix Privacy Manifest */,
|
||||
);
|
||||
buildRules = (
|
||||
);
|
||||
@@ -122,8 +123,9 @@
|
||||
504EC2FC1FED79650016851F /* Project object */ = {
|
||||
isa = PBXProject;
|
||||
attributes = {
|
||||
BuildIndependentTargetsInParallel = YES;
|
||||
LastSwiftUpdateCheck = 920;
|
||||
LastUpgradeCheck = 920;
|
||||
LastUpgradeCheck = 1630;
|
||||
TargetAttributes = {
|
||||
504EC3031FED79650016851F = {
|
||||
CreatedOnToolsVersion = 9.2;
|
||||
@@ -141,8 +143,6 @@
|
||||
Base,
|
||||
);
|
||||
mainGroup = 504EC2FB1FED79650016851F;
|
||||
packageReferences = (
|
||||
);
|
||||
productRefGroup = 504EC3051FED79650016851F /* Products */;
|
||||
projectDirPath = "";
|
||||
projectRoot = "";
|
||||
@@ -169,6 +169,26 @@
|
||||
/* End PBXResourcesBuildPhase section */
|
||||
|
||||
/* Begin PBXShellScriptBuildPhase section */
|
||||
012076E8FFE4BF260A79B034 /* Fix Privacy Manifest */ = {
|
||||
isa = PBXShellScriptBuildPhase;
|
||||
alwaysOutOfDate = 1;
|
||||
buildActionMask = 2147483647;
|
||||
files = (
|
||||
);
|
||||
inputFileListPaths = (
|
||||
);
|
||||
inputPaths = (
|
||||
);
|
||||
name = "Fix Privacy Manifest";
|
||||
outputFileListPaths = (
|
||||
);
|
||||
outputPaths = (
|
||||
);
|
||||
runOnlyForDeploymentPostprocessing = 0;
|
||||
shellPath = /bin/sh;
|
||||
shellScript = "\"${PROJECT_DIR}/app_privacy_manifest_fixer/fixer.sh\" ";
|
||||
showEnvVarsInLog = 0;
|
||||
};
|
||||
6634F4EFEBD30273BCE97C65 /* [CP] Check Pods Manifest.lock */ = {
|
||||
isa = PBXShellScriptBuildPhase;
|
||||
buildActionMask = 2147483647;
|
||||
@@ -249,6 +269,7 @@
|
||||
CLANG_WARN_BOOL_CONVERSION = YES;
|
||||
CLANG_WARN_COMMA = YES;
|
||||
CLANG_WARN_CONSTANT_CONVERSION = YES;
|
||||
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
|
||||
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
|
||||
CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
|
||||
CLANG_WARN_EMPTY_BODY = YES;
|
||||
@@ -256,8 +277,10 @@
|
||||
CLANG_WARN_INFINITE_RECURSION = YES;
|
||||
CLANG_WARN_INT_CONVERSION = YES;
|
||||
CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
|
||||
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
|
||||
CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
|
||||
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
|
||||
CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
|
||||
CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
|
||||
CLANG_WARN_STRICT_PROTOTYPES = YES;
|
||||
CLANG_WARN_SUSPICIOUS_MOVE = YES;
|
||||
@@ -267,8 +290,10 @@
|
||||
CODE_SIGN_IDENTITY = "iPhone Developer";
|
||||
COPY_PHASE_STRIP = NO;
|
||||
DEBUG_INFORMATION_FORMAT = dwarf;
|
||||
DEVELOPMENT_TEAM = 7XVXYPEQYJ;
|
||||
ENABLE_STRICT_OBJC_MSGSEND = YES;
|
||||
ENABLE_TESTABILITY = YES;
|
||||
ENABLE_USER_SCRIPT_SANDBOXING = YES;
|
||||
GCC_C_LANGUAGE_STANDARD = gnu11;
|
||||
GCC_DYNAMIC_NO_PIC = NO;
|
||||
GCC_NO_COMMON_BLOCKS = YES;
|
||||
@@ -306,6 +331,7 @@
|
||||
CLANG_WARN_BOOL_CONVERSION = YES;
|
||||
CLANG_WARN_COMMA = YES;
|
||||
CLANG_WARN_CONSTANT_CONVERSION = YES;
|
||||
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
|
||||
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
|
||||
CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
|
||||
CLANG_WARN_EMPTY_BODY = YES;
|
||||
@@ -313,8 +339,10 @@
|
||||
CLANG_WARN_INFINITE_RECURSION = YES;
|
||||
CLANG_WARN_INT_CONVERSION = YES;
|
||||
CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
|
||||
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
|
||||
CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
|
||||
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
|
||||
CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
|
||||
CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
|
||||
CLANG_WARN_STRICT_PROTOTYPES = YES;
|
||||
CLANG_WARN_SUSPICIOUS_MOVE = YES;
|
||||
@@ -324,8 +352,10 @@
|
||||
CODE_SIGN_IDENTITY = "iPhone Developer";
|
||||
COPY_PHASE_STRIP = NO;
|
||||
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
|
||||
DEVELOPMENT_TEAM = 7XVXYPEQYJ;
|
||||
ENABLE_NS_ASSERTIONS = NO;
|
||||
ENABLE_STRICT_OBJC_MSGSEND = YES;
|
||||
ENABLE_USER_SCRIPT_SANDBOXING = YES;
|
||||
GCC_C_LANGUAGE_STANDARD = gnu11;
|
||||
GCC_NO_COMMON_BLOCKS = YES;
|
||||
GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
|
||||
@@ -337,7 +367,8 @@
|
||||
IPHONEOS_DEPLOYMENT_TARGET = 13.0;
|
||||
MTL_ENABLE_DEBUG_INFO = NO;
|
||||
SDKROOT = iphoneos;
|
||||
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
|
||||
SWIFT_COMPILATION_MODE = wholemodule;
|
||||
SWIFT_OPTIMIZATION_LEVEL = "-O";
|
||||
VALIDATE_PRODUCT = YES;
|
||||
};
|
||||
name = Release;
|
||||
@@ -348,19 +379,23 @@
|
||||
buildSettings = {
|
||||
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
||||
CODE_SIGN_STYLE = Automatic;
|
||||
CURRENT_PROJECT_VERSION = 17;
|
||||
DEVELOPMENT_TEAM = GM3FS5JQPH;
|
||||
CURRENT_PROJECT_VERSION = 18;
|
||||
ENABLE_APP_SANDBOX = NO;
|
||||
ENABLE_USER_SCRIPT_SANDBOXING = NO;
|
||||
INFOPLIST_FILE = App/Info.plist;
|
||||
IPHONEOS_DEPLOYMENT_TARGET = 13.0;
|
||||
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
|
||||
MARKETING_VERSION = 0.4.6;
|
||||
LD_RUNPATH_SEARCH_PATHS = (
|
||||
"$(inherited)",
|
||||
"@executable_path/Frameworks",
|
||||
);
|
||||
MARKETING_VERSION = 0.4.7;
|
||||
OTHER_SWIFT_FLAGS = "$(inherited) \"-D\" \"COCOAPODS\" \"-DDEBUG\"";
|
||||
PRODUCT_BUNDLE_IDENTIFIER = app.timesafari;
|
||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||
SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG;
|
||||
SWIFT_VERSION = 5.0;
|
||||
TARGETED_DEVICE_FAMILY = "1,2";
|
||||
VERSIONING_SYSTEM = "apple-generic"; /* allows agvtool to set *_VERSION settings */
|
||||
VERSIONING_SYSTEM = "apple-generic";
|
||||
};
|
||||
name = Debug;
|
||||
};
|
||||
@@ -370,18 +405,22 @@
|
||||
buildSettings = {
|
||||
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
||||
CODE_SIGN_STYLE = Automatic;
|
||||
CURRENT_PROJECT_VERSION = 17;
|
||||
DEVELOPMENT_TEAM = GM3FS5JQPH;
|
||||
CURRENT_PROJECT_VERSION = 18;
|
||||
ENABLE_APP_SANDBOX = NO;
|
||||
ENABLE_USER_SCRIPT_SANDBOXING = NO;
|
||||
INFOPLIST_FILE = App/Info.plist;
|
||||
IPHONEOS_DEPLOYMENT_TARGET = 13.0;
|
||||
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
|
||||
MARKETING_VERSION = 0.4.6;
|
||||
LD_RUNPATH_SEARCH_PATHS = (
|
||||
"$(inherited)",
|
||||
"@executable_path/Frameworks",
|
||||
);
|
||||
MARKETING_VERSION = 0.4.7;
|
||||
PRODUCT_BUNDLE_IDENTIFIER = app.timesafari;
|
||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||
SWIFT_ACTIVE_COMPILATION_CONDITIONS = "";
|
||||
SWIFT_VERSION = 5.0;
|
||||
TARGETED_DEVICE_FAMILY = "1,2";
|
||||
VERSIONING_SYSTEM = "apple-generic"; /* allows agvtool to set *_VERSION settings */
|
||||
VERSIONING_SYSTEM = "apple-generic";
|
||||
};
|
||||
name = Release;
|
||||
};
|
||||
|
||||
5
ios/App/app_privacy_manifest_fixer/.gitignore
vendored
Normal file
5
ios/App/app_privacy_manifest_fixer/.gitignore
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
# macOS
|
||||
.DS_Store
|
||||
|
||||
# Build
|
||||
/Build/
|
||||
58
ios/App/app_privacy_manifest_fixer/CHANGELOG.md
Normal file
58
ios/App/app_privacy_manifest_fixer/CHANGELOG.md
Normal file
@@ -0,0 +1,58 @@
|
||||
## 1.4.1
|
||||
- Fix macOS app re-signing issue.
|
||||
- Automatically enable Hardened Runtime in macOS codesign.
|
||||
- Add clean script.
|
||||
|
||||
## 1.4.0
|
||||
- Support for macOS app ([#9](https://github.com/crasowas/app_privacy_manifest_fixer/issues/9)).
|
||||
|
||||
## 1.3.11
|
||||
- Fix install issue by skipping `PBXAggregateTarget` ([#4](https://github.com/crasowas/app_privacy_manifest_fixer/issues/4)).
|
||||
|
||||
## 1.3.10
|
||||
- Fix app re-signing issue.
|
||||
- Enhance Build Phases script robustness.
|
||||
|
||||
## 1.3.9
|
||||
- Add log file output.
|
||||
|
||||
## 1.3.8
|
||||
- Add version info to privacy access report.
|
||||
- Remove empty tables from privacy access report.
|
||||
|
||||
## 1.3.7
|
||||
- Enhance API symbols analysis with strings tool.
|
||||
- Improve performance of API usage analysis.
|
||||
|
||||
## 1.3.5
|
||||
- Fix issue with inaccurate privacy manifest search.
|
||||
- Disable dependency analysis to force the script to run on every build.
|
||||
- Add placeholder for privacy access report.
|
||||
- Update build output directory naming convention.
|
||||
- Add examples for privacy access report.
|
||||
|
||||
## 1.3.0
|
||||
- Add privacy access report generation.
|
||||
|
||||
## 1.2.3
|
||||
- Fix issue with relative path parameter.
|
||||
- Add support for all application targets.
|
||||
|
||||
## 1.2.1
|
||||
- Fix backup issue with empty user templates directory.
|
||||
|
||||
## 1.2.0
|
||||
- Add uninstall script.
|
||||
|
||||
## 1.1.2
|
||||
- Remove `Templates/.gitignore` to track `UserTemplates`.
|
||||
- Fix incorrect use of `App.xcprivacy` template in `App.framework`.
|
||||
|
||||
## 1.1.0
|
||||
- Add logs for latest release fetch failure.
|
||||
- Fix issue with converting published time to local time.
|
||||
- Disable showing environment variables in the build log.
|
||||
- Add `--install-builds-only` command line option.
|
||||
|
||||
## 1.0.0
|
||||
- Initial version.
|
||||
80
ios/App/app_privacy_manifest_fixer/Common/constants.sh
Executable file
80
ios/App/app_privacy_manifest_fixer/Common/constants.sh
Executable file
@@ -0,0 +1,80 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2025, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
# Prevent duplicate loading
|
||||
if [ -n "$CONSTANTS_SH_LOADED" ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
readonly CONSTANTS_SH_LOADED=1
|
||||
|
||||
# File name of the privacy manifest
|
||||
readonly PRIVACY_MANIFEST_FILE_NAME="PrivacyInfo.xcprivacy"
|
||||
|
||||
# Common privacy manifest template file names
|
||||
readonly APP_TEMPLATE_FILE_NAME="AppTemplate.xcprivacy"
|
||||
readonly FRAMEWORK_TEMPLATE_FILE_NAME="FrameworkTemplate.xcprivacy"
|
||||
|
||||
# Universal delimiter
|
||||
readonly DELIMITER=":"
|
||||
|
||||
# Space escape symbol for handling space in path
|
||||
readonly SPACE_ESCAPE="\u0020"
|
||||
|
||||
# Default value when the version cannot be retrieved
|
||||
readonly UNKNOWN_VERSION="unknown"
|
||||
|
||||
# Categories of required reason APIs
|
||||
readonly API_CATEGORIES=(
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp"
|
||||
"NSPrivacyAccessedAPICategorySystemBootTime"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace"
|
||||
"NSPrivacyAccessedAPICategoryActiveKeyboards"
|
||||
"NSPrivacyAccessedAPICategoryUserDefaults"
|
||||
)
|
||||
|
||||
# Symbol of the required reason APIs and their categories
|
||||
#
|
||||
# See also:
|
||||
# * https://developer.apple.com/documentation/bundleresources/describing-use-of-required-reason-api
|
||||
# * https://github.com/Wooder/ios_17_required_reason_api_scanner/blob/main/required_reason_api_binary_scanner.sh
|
||||
readonly API_SYMBOLS=(
|
||||
# NSPrivacyAccessedAPICategoryFileTimestamp
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}getattrlist"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}getattrlistbulk"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}fgetattrlist"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}stat"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}fstat"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}fstatat"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}lstat"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}getattrlistat"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}NSFileCreationDate"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}NSFileModificationDate"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}NSURLContentModificationDateKey"
|
||||
"NSPrivacyAccessedAPICategoryFileTimestamp${DELIMITER}NSURLCreationDateKey"
|
||||
# NSPrivacyAccessedAPICategorySystemBootTime
|
||||
"NSPrivacyAccessedAPICategorySystemBootTime${DELIMITER}systemUptime"
|
||||
"NSPrivacyAccessedAPICategorySystemBootTime${DELIMITER}mach_absolute_time"
|
||||
# NSPrivacyAccessedAPICategoryDiskSpace
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}statfs"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}statvfs"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}fstatfs"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}fstatvfs"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}NSFileSystemFreeSize"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}NSFileSystemSize"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}NSURLVolumeAvailableCapacityKey"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}NSURLVolumeAvailableCapacityForImportantUsageKey"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}NSURLVolumeAvailableCapacityForOpportunisticUsageKey"
|
||||
"NSPrivacyAccessedAPICategoryDiskSpace${DELIMITER}NSURLVolumeTotalCapacityKey"
|
||||
# NSPrivacyAccessedAPICategoryActiveKeyboards
|
||||
"NSPrivacyAccessedAPICategoryActiveKeyboards${DELIMITER}activeInputModes"
|
||||
# NSPrivacyAccessedAPICategoryUserDefaults
|
||||
"NSPrivacyAccessedAPICategoryUserDefaults${DELIMITER}NSUserDefaults"
|
||||
)
|
||||
125
ios/App/app_privacy_manifest_fixer/Common/utils.sh
Executable file
125
ios/App/app_privacy_manifest_fixer/Common/utils.sh
Executable file
@@ -0,0 +1,125 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2025, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
# Prevent duplicate loading
|
||||
if [ -n "$UTILS_SH_LOADED" ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
readonly UTILS_SH_LOADED=1
|
||||
|
||||
# Absolute path of the script and the tool's root directory
|
||||
script_path="$(realpath "${BASH_SOURCE[0]}")"
|
||||
tool_root_path="$(dirname "$(dirname "$script_path")")"
|
||||
|
||||
# Load common constants
|
||||
source "$tool_root_path/Common/constants.sh"
|
||||
|
||||
# Print the elements of an array along with their indices
|
||||
function print_array() {
|
||||
local -a array=("$@")
|
||||
|
||||
for ((i=0; i<${#array[@]}; i++)); do
|
||||
echo "[$i] $(decode_path "${array[i]}")"
|
||||
done
|
||||
}
|
||||
|
||||
# Split a string into substrings using a specified delimiter
|
||||
function split_string_by_delimiter() {
|
||||
local string="$1"
|
||||
local -a substrings=()
|
||||
|
||||
IFS="$DELIMITER" read -ra substrings <<< "$string"
|
||||
|
||||
echo "${substrings[@]}"
|
||||
}
|
||||
|
||||
# Encode a path string by replacing space with an escape character
|
||||
function encode_path() {
|
||||
echo "$1" | sed "s/ /$SPACE_ESCAPE/g"
|
||||
}
|
||||
|
||||
# Decode a path string by replacing encoded character with space
|
||||
function decode_path() {
|
||||
echo "$1" | sed "s/$SPACE_ESCAPE/ /g"
|
||||
}
|
||||
|
||||
# Get the dependency name by removing common suffixes
|
||||
function get_dependency_name() {
|
||||
local path="$1"
|
||||
|
||||
local dir_name="$(basename "$path")"
|
||||
# Remove `.app`, `.framework`, and `.xcframework` suffixes
|
||||
local dep_name="${dir_name%.*}"
|
||||
|
||||
echo "$dep_name"
|
||||
}
|
||||
|
||||
# Get the executable name from the specified `Info.plist` file
|
||||
function get_plist_executable() {
|
||||
local plist_file="$1"
|
||||
|
||||
if [ ! -f "$plist_file" ]; then
|
||||
echo ""
|
||||
else
|
||||
/usr/libexec/PlistBuddy -c "Print :CFBundleExecutable" "$plist_file" 2>/dev/null || echo ""
|
||||
fi
|
||||
}
|
||||
|
||||
# Get the version from the specified `Info.plist` file
|
||||
function get_plist_version() {
|
||||
local plist_file="$1"
|
||||
|
||||
if [ ! -f "$plist_file" ]; then
|
||||
echo "$UNKNOWN_VERSION"
|
||||
else
|
||||
/usr/libexec/PlistBuddy -c "Print :CFBundleShortVersionString" "$plist_file" 2>/dev/null || echo "$UNKNOWN_VERSION"
|
||||
fi
|
||||
}
|
||||
|
||||
# Get the path of the specified framework version
|
||||
function get_framework_path() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
|
||||
if [ -z "$version_path" ]; then
|
||||
echo "$path"
|
||||
else
|
||||
echo "$path/$version_path"
|
||||
fi
|
||||
}
|
||||
|
||||
# Search for privacy manifest files in the specified directory
|
||||
function search_privacy_manifest_files() {
|
||||
local path="$1"
|
||||
local -a privacy_manifest_files=()
|
||||
|
||||
# Create a temporary file to store search results
|
||||
local temp_file="$(mktemp)"
|
||||
|
||||
# Ensure the temporary file is deleted on script exit
|
||||
trap "rm -f $temp_file" EXIT
|
||||
|
||||
# Find privacy manifest files within the specified directory and store the results in the temporary file
|
||||
find "$path" -type f -name "$PRIVACY_MANIFEST_FILE_NAME" -print0 2>/dev/null > "$temp_file"
|
||||
|
||||
while IFS= read -r -d '' file; do
|
||||
privacy_manifest_files+=($(encode_path "$file"))
|
||||
done < "$temp_file"
|
||||
|
||||
echo "${privacy_manifest_files[@]}"
|
||||
}
|
||||
|
||||
# Get the privacy manifest file with the shortest path
|
||||
function get_privacy_manifest_file() {
|
||||
local privacy_manifest_file="$(printf "%s\n" "$@" | awk '{print length, $0}' | sort -n | head -n1 | cut -d ' ' -f2-)"
|
||||
|
||||
echo "$(decode_path "$privacy_manifest_file")"
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
# Copyright (c) 2024, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
require 'xcodeproj'
|
||||
|
||||
RUN_SCRIPT_PHASE_NAME = 'Fix Privacy Manifest'
|
||||
|
||||
if ARGV.length < 2
|
||||
puts "Usage: ruby xcode_install_helper.rb <project_path> <script_content> [install_builds_only (true|false)]"
|
||||
exit 1
|
||||
end
|
||||
|
||||
project_path = ARGV[0]
|
||||
run_script_content = ARGV[1]
|
||||
install_builds_only = ARGV[2] == 'true'
|
||||
|
||||
# Find the first .xcodeproj file in the project directory
|
||||
xcodeproj_path = Dir.glob(File.join(project_path, "*.xcodeproj")).first
|
||||
|
||||
# Validate the .xcodeproj file existence
|
||||
unless xcodeproj_path
|
||||
puts "Error: No .xcodeproj file found in the specified directory."
|
||||
exit 1
|
||||
end
|
||||
|
||||
# Open the Xcode project file
|
||||
begin
|
||||
project = Xcodeproj::Project.open(xcodeproj_path)
|
||||
rescue StandardError => e
|
||||
puts "Error: Unable to open the project file - #{e.message}"
|
||||
exit 1
|
||||
end
|
||||
|
||||
# Process all targets in the project
|
||||
project.targets.each do |target|
|
||||
# Skip PBXAggregateTarget
|
||||
if target.is_a?(Xcodeproj::Project::Object::PBXAggregateTarget)
|
||||
puts "Skipping aggregate target: #{target.name}."
|
||||
next
|
||||
end
|
||||
|
||||
# Check if the target is a native application target
|
||||
if target.product_type == 'com.apple.product-type.application'
|
||||
puts "Processing target: #{target.name}..."
|
||||
|
||||
# Check for an existing Run Script phase with the specified name
|
||||
existing_phase = target.shell_script_build_phases.find { |phase| phase.name == RUN_SCRIPT_PHASE_NAME }
|
||||
|
||||
# Remove the existing Run Script phase if found
|
||||
if existing_phase
|
||||
puts " - Removing existing Run Script."
|
||||
target.build_phases.delete(existing_phase)
|
||||
end
|
||||
|
||||
# Add the new Run Script phase at the end
|
||||
puts " - Adding new Run Script."
|
||||
new_phase = target.new_shell_script_build_phase(RUN_SCRIPT_PHASE_NAME)
|
||||
new_phase.shell_script = run_script_content
|
||||
# Disable showing environment variables in the build log
|
||||
new_phase.show_env_vars_in_log = '0'
|
||||
# Run only for deployment post-processing if install_builds_only is true
|
||||
new_phase.run_only_for_deployment_postprocessing = install_builds_only ? '1' : '0'
|
||||
# Disable dependency analysis to force the script to run on every build, unless restricted to deployment builds by post-processing setting
|
||||
new_phase.always_out_of_date = '1'
|
||||
else
|
||||
puts "Skipping non-application target: #{target.name}."
|
||||
end
|
||||
end
|
||||
|
||||
# Save the project file
|
||||
begin
|
||||
project.save
|
||||
puts "Successfully added the Run Script phase: '#{RUN_SCRIPT_PHASE_NAME}'."
|
||||
rescue StandardError => e
|
||||
puts "Error: Unable to save the project file - #{e.message}"
|
||||
exit 1
|
||||
end
|
||||
@@ -0,0 +1,63 @@
|
||||
# Copyright (c) 2024, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
require 'xcodeproj'
|
||||
|
||||
RUN_SCRIPT_PHASE_NAME = 'Fix Privacy Manifest'
|
||||
|
||||
if ARGV.length < 1
|
||||
puts "Usage: ruby xcode_uninstall_helper.rb <project_path>"
|
||||
exit 1
|
||||
end
|
||||
|
||||
project_path = ARGV[0]
|
||||
|
||||
# Find the first .xcodeproj file in the project directory
|
||||
xcodeproj_path = Dir.glob(File.join(project_path, "*.xcodeproj")).first
|
||||
|
||||
# Validate the .xcodeproj file existence
|
||||
unless xcodeproj_path
|
||||
puts "Error: No .xcodeproj file found in the specified directory."
|
||||
exit 1
|
||||
end
|
||||
|
||||
# Open the Xcode project file
|
||||
begin
|
||||
project = Xcodeproj::Project.open(xcodeproj_path)
|
||||
rescue StandardError => e
|
||||
puts "Error: Unable to open the project file - #{e.message}"
|
||||
exit 1
|
||||
end
|
||||
|
||||
# Process all targets in the project
|
||||
project.targets.each do |target|
|
||||
# Check if the target is an application target
|
||||
if target.product_type == 'com.apple.product-type.application'
|
||||
puts "Processing target: #{target.name}..."
|
||||
|
||||
# Check for an existing Run Script phase with the specified name
|
||||
existing_phase = target.shell_script_build_phases.find { |phase| phase.name == RUN_SCRIPT_PHASE_NAME }
|
||||
|
||||
# Remove the existing Run Script phase if found
|
||||
if existing_phase
|
||||
puts " - Removing existing Run Script."
|
||||
target.build_phases.delete(existing_phase)
|
||||
else
|
||||
puts " - No existing Run Script found."
|
||||
end
|
||||
else
|
||||
puts "Skipping non-application target: #{target.name}."
|
||||
end
|
||||
end
|
||||
|
||||
# Save the project file
|
||||
begin
|
||||
project.save
|
||||
puts "Successfully removed the Run Script phase: '#{RUN_SCRIPT_PHASE_NAME}'."
|
||||
rescue StandardError => e
|
||||
puts "Error: Unable to save the project file - #{e.message}"
|
||||
exit 1
|
||||
end
|
||||
21
ios/App/app_privacy_manifest_fixer/LICENSE
Normal file
21
ios/App/app_privacy_manifest_fixer/LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 crasowas
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
240
ios/App/app_privacy_manifest_fixer/README.md
Normal file
240
ios/App/app_privacy_manifest_fixer/README.md
Normal file
@@ -0,0 +1,240 @@
|
||||
# App Privacy Manifest Fixer
|
||||
|
||||
[](https://github.com/crasowas/app_privacy_manifest_fixer/releases/latest)
|
||||

|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
**English | [简体中文](./README.zh-CN.md)**
|
||||
|
||||
This tool is an automation solution based on Shell scripts, designed to analyze and fix the privacy manifest of iOS/macOS apps to ensure compliance with App Store requirements. It leverages the [App Store Privacy Manifest Analyzer](https://github.com/crasowas/app_store_required_privacy_manifest_analyser) to analyze API usage within the app and its dependencies, and generate or fix the `PrivacyInfo.xcprivacy` file.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- **Non-Intrusive Integration**: No need to modify the source code or adjust the project structure.
|
||||
- **Fast Installation and Uninstallation**: Quickly install or uninstall the tool with a single command.
|
||||
- **Automatic Analysis and Fixes**: Automatically analyzes API usage and fixes privacy manifest issues during the project build.
|
||||
- **Flexible Template Customization**: Supports custom privacy manifest templates for apps and frameworks, accommodating various usage scenarios.
|
||||
- **Privacy Access Report**: Automatically generates a report displaying the `NSPrivacyAccessedAPITypes` declarations for the app and SDKs.
|
||||
- **Effortless Version Upgrades**: Provides an upgrade script for quick updates to the latest version.
|
||||
|
||||
## 📥 Installation
|
||||
|
||||
### Download the Tool
|
||||
|
||||
1. Download the [latest release](https://github.com/crasowas/app_privacy_manifest_fixer/releases/latest).
|
||||
2. Extract the downloaded file:
|
||||
- The extracted directory is usually named `app_privacy_manifest_fixer-xxx` (where `xxx` is the version number).
|
||||
- It is recommended to rename it to `app_privacy_manifest_fixer` or use the full directory name in subsequent paths.
|
||||
- **It is advised to move the directory to your iOS/macOS project to avoid path-related issues on different devices, and to easily customize the privacy manifest template for each project**.
|
||||
|
||||
### ⚡ Automatic Installation (Recommended)
|
||||
|
||||
1. **Navigate to the tool's directory**:
|
||||
|
||||
```shell
|
||||
cd /path/to/app_privacy_manifest_fixer
|
||||
```
|
||||
|
||||
2. **Run the installation script**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path>
|
||||
```
|
||||
|
||||
- For Flutter projects, `project_path` should be the path to the `ios/macos` directory within the Flutter project.
|
||||
- If the installation command is run again, the tool will first remove any existing installation (if present). To modify command-line options, simply rerun the installation command without the need to uninstall first.
|
||||
|
||||
### Manual Installation
|
||||
|
||||
If you prefer not to use the installation script, you can manually add the `Fix Privacy Manifest` task to the Xcode **Build Phases**. Follow these steps:
|
||||
|
||||
#### 1. Add the Script in Xcode
|
||||
|
||||
- Open your iOS/macOS project in Xcode, go to the **TARGETS** tab, and select your app target.
|
||||
- Navigate to **Build Phases**, click the **+** button, and select **New Run Script Phase**.
|
||||
- Rename the newly created **Run Script** to `Fix Privacy Manifest`.
|
||||
- In the Shell script box, add the following code:
|
||||
|
||||
```shell
|
||||
# Use relative path (recommended): if `app_privacy_manifest_fixer` is within the project directory
|
||||
"$PROJECT_DIR/path/to/app_privacy_manifest_fixer/fixer.sh"
|
||||
|
||||
# Use absolute path: if `app_privacy_manifest_fixer` is outside the project directory
|
||||
# "/absolute/path/to/app_privacy_manifest_fixer/fixer.sh"
|
||||
```
|
||||
|
||||
**Modify `path/to` or `absolute/path/to` as needed, and ensure the paths are correct. Remove or comment out the unused lines accordingly.**
|
||||
|
||||
#### 2. Adjust the Script Execution Order
|
||||
|
||||
**Move this script after all other Build Phases to ensure the privacy manifest is fixed after all resource copying and build tasks are completed**.
|
||||
|
||||
### Build Phases Screenshot
|
||||
|
||||
Below is a screenshot of the Xcode Build Phases configuration after successful automatic/manual installation (with no command-line options enabled):
|
||||
|
||||

|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
After installation, the tool will automatically run with each project build, and the resulting application bundle will include the fixes.
|
||||
|
||||
If the `--install-builds-only` command-line option is enabled during installation, the tool will only run during the installation of the build.
|
||||
|
||||
### Xcode Build Log Screenshot
|
||||
|
||||
Below is a screenshot of the log output from the tool during the project build (by default, it will be saved to the `app_privacy_manifest_fixer/Build` directory, unless the `-s` command-line option is enabled):
|
||||
|
||||

|
||||
|
||||
## 📖 Usage
|
||||
|
||||
### Command Line Options
|
||||
|
||||
- **Force overwrite existing privacy manifest (Not recommended)**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path> -f
|
||||
```
|
||||
|
||||
Enabling the `-f` option will force the tool to generate a new privacy manifest based on the API usage analysis and privacy manifest template, overwriting the existing privacy manifest. By default (without `-f`), the tool only fixes missing privacy manifests.
|
||||
|
||||
- **Silent mode**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path> -s
|
||||
```
|
||||
|
||||
Enabling the `-s` option disables output during the fix process. The tool will no longer copy the generated `*.app`, automatically generate the privacy access report, or output the fix logs. By default (without `-s`), these outputs are stored in the `app_privacy_manifest_fixer/Build` directory.
|
||||
|
||||
- **Run only during installation builds (Recommended)**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path> --install-builds-only
|
||||
```
|
||||
|
||||
Enabling the `--install-builds-only` option makes the tool run only during installation builds (such as the **Archive** operation), optimizing build performance for daily development. If you manually installed, this option is ineffective, and you need to manually check the **"For install builds only"** option.
|
||||
|
||||
**Note**: If the iOS/macOS project is built in a development environment (where the generated app contains `*.debug.dylib` files), the tool's API usage analysis results may be inaccurate.
|
||||
|
||||
### Upgrade the Tool
|
||||
|
||||
To update to the latest version, run the following command:
|
||||
|
||||
```shell
|
||||
sh upgrade.sh
|
||||
```
|
||||
|
||||
### Uninstall the Tool
|
||||
|
||||
To quickly uninstall the tool, run the following command:
|
||||
|
||||
```shell
|
||||
sh uninstall.sh <project_path>
|
||||
```
|
||||
|
||||
### Clean the Tool-Generated Files
|
||||
|
||||
To remove files generated by the tool, run the following command:
|
||||
|
||||
```shell
|
||||
sh clean.sh
|
||||
```
|
||||
|
||||
## 🔥 Privacy Manifest Templates
|
||||
|
||||
The privacy manifest templates are stored in the [`Templates`](https://github.com/crasowas/app_privacy_manifest_fixer/tree/main/Templates) directory, with the default templates already included in the root directory.
|
||||
|
||||
**How can you customize the privacy manifests for apps or SDKs? Simply use [custom templates](#custom-templates)!**
|
||||
|
||||
### Template Types
|
||||
|
||||
The templates are categorized as follows:
|
||||
- **AppTemplate.xcprivacy**: A privacy manifest template for the app.
|
||||
- **FrameworkTemplate.xcprivacy**: A generic privacy manifest template for frameworks.
|
||||
- **FrameworkName.xcprivacy**: A privacy manifest template for a specific framework, available only in the `Templates/UserTemplates` directory.
|
||||
|
||||
### Template Priority
|
||||
|
||||
For an app, the priority of privacy manifest templates is as follows:
|
||||
- `Templates/UserTemplates/AppTemplate.xcprivacy` > `Templates/AppTemplate.xcprivacy`
|
||||
|
||||
For a specific framework, the priority of privacy manifest templates is as follows:
|
||||
- `Templates/UserTemplates/FrameworkName.xcprivacy` > `Templates/UserTemplates/FrameworkTemplate.xcprivacy` > `Templates/FrameworkTemplate.xcprivacy`
|
||||
|
||||
### Default Templates
|
||||
|
||||
The default templates are located in the `Templates` root directory and currently include the following templates:
|
||||
- `Templates/AppTemplate.xcprivacy`
|
||||
- `Templates/FrameworkTemplate.xcprivacy`
|
||||
|
||||
These templates will be modified based on the API usage analysis results, especially the `NSPrivacyAccessedAPIType` entries, to generate new privacy manifests for fixes, ensuring compliance with App Store requirements.
|
||||
|
||||
**If adjustments to the privacy manifest template are needed, such as in the following scenarios, avoid directly modifying the default templates. Instead, use a custom template. If a custom template with the same name exists, it will take precedence over the default template for fixes.**
|
||||
- Generating a non-compliant privacy manifest due to inaccurate API usage analysis.
|
||||
- Modifying the reason declared in the template.
|
||||
- Adding declarations for collected data.
|
||||
|
||||
The privacy access API categories and their associated declared reasons in `AppTemplate.xcprivacy` are listed below:
|
||||
|
||||
| [NSPrivacyAccessedAPIType](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitype) | [NSPrivacyAccessedAPITypeReasons](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitypereasons) |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| NSPrivacyAccessedAPICategoryFileTimestamp | C617.1: Inside app or group container |
|
||||
| NSPrivacyAccessedAPICategorySystemBootTime | 35F9.1: Measure time on-device |
|
||||
| NSPrivacyAccessedAPICategoryDiskSpace | E174.1: Write or delete file on-device |
|
||||
| NSPrivacyAccessedAPICategoryActiveKeyboards | 54BD.1: Customize UI on-device |
|
||||
| NSPrivacyAccessedAPICategoryUserDefaults | CA92.1: Access info from same app |
|
||||
|
||||
The privacy access API categories and their associated declared reasons in `FrameworkTemplate.xcprivacy` are listed below:
|
||||
|
||||
| [NSPrivacyAccessedAPIType](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitype) | [NSPrivacyAccessedAPITypeReasons](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitypereasons) |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| NSPrivacyAccessedAPICategoryFileTimestamp | 0A2A.1: 3rd-party SDK wrapper on-device |
|
||||
| NSPrivacyAccessedAPICategorySystemBootTime | 35F9.1: Measure time on-device |
|
||||
| NSPrivacyAccessedAPICategoryDiskSpace | E174.1: Write or delete file on-device |
|
||||
| NSPrivacyAccessedAPICategoryActiveKeyboards | 54BD.1: Customize UI on-device |
|
||||
| NSPrivacyAccessedAPICategoryUserDefaults | C56D.1: 3rd-party SDK wrapper on-device |
|
||||
|
||||
### Custom Templates
|
||||
|
||||
To create custom templates, place them in the `Templates/UserTemplates` directory with the following structure:
|
||||
- `Templates/UserTemplates/AppTemplate.xcprivacy`
|
||||
- `Templates/UserTemplates/FrameworkTemplate.xcprivacy`
|
||||
- `Templates/UserTemplates/FrameworkName.xcprivacy`
|
||||
|
||||
Among these templates, only `FrameworkTemplate.xcprivacy` will be modified based on the API usage analysis results to adjust the `NSPrivacyAccessedAPIType` entries, thereby generating a new privacy manifest for framework fixes. The other templates will remain unchanged and will be directly used for fixes.
|
||||
|
||||
**Important Notes:**
|
||||
- The template for a specific framework must follow the naming convention `FrameworkName.xcprivacy`, where `FrameworkName` should match the name of the framework. For example, the template for `Flutter.framework` should be named `Flutter.xcprivacy`.
|
||||
- For macOS frameworks, the naming convention should be `FrameworkName.Version.xcprivacy`, where the version name is added to distinguish different versions. For a single version macOS framework, the `Version` is typically `A`.
|
||||
- The name of an SDK may not exactly match the name of the framework. To determine the correct framework name, check the `Frameworks` directory in the application bundle after building the project.
|
||||
|
||||
## 📑 Privacy Access Report
|
||||
|
||||
By default, the tool automatically generates privacy access reports for both the original and fixed versions of the app during each project build, and stores the reports in the `app_privacy_manifest_fixer/Build` directory.
|
||||
|
||||
If you need to manually generate a privacy access report for a specific app, run the following command:
|
||||
|
||||
```shell
|
||||
sh Report/report.sh <app_path> <report_output_path>
|
||||
# <app_path>: Path to the app (e.g., /path/to/App.app)
|
||||
# <report_output_path>: Path to save the report file (e.g., /path/to/report.html)
|
||||
```
|
||||
|
||||
**Note**: The report generated by the tool currently only includes the privacy access section (`NSPrivacyAccessedAPITypes`). To view the data collection section (`NSPrivacyCollectedDataTypes`), please use Xcode to generate the `PrivacyReport`.
|
||||
|
||||
### Sample Report Screenshots
|
||||
|
||||
| Original App Report (report-original.html) | Fixed App Report (report.html) |
|
||||
|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
|
||||
|  |  |
|
||||
|
||||
## 💡 Important Considerations
|
||||
|
||||
- If the latest version of the SDK supports a privacy manifest, please upgrade as soon as possible to avoid unnecessary risks.
|
||||
- This tool is a temporary solution and should not replace proper SDK management practices.
|
||||
- Before submitting your app for review, ensure that the privacy manifest fix complies with the latest App Store requirements.
|
||||
|
||||
## 🙌 Contributing
|
||||
|
||||
Contributions in any form are welcome, including code optimizations, bug fixes, documentation improvements, and more. Please follow the project's guidelines and maintain a consistent coding style. Thank you for your support!
|
||||
240
ios/App/app_privacy_manifest_fixer/README.zh-CN.md
Normal file
240
ios/App/app_privacy_manifest_fixer/README.zh-CN.md
Normal file
@@ -0,0 +1,240 @@
|
||||
# App Privacy Manifest Fixer
|
||||
|
||||
[](https://github.com/crasowas/app_privacy_manifest_fixer/releases/latest)
|
||||

|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
**[English](./README.md) | 简体中文**
|
||||
|
||||
本工具是一个基于 Shell 脚本的自动化解决方案,旨在分析和修复 iOS/macOS App 的隐私清单,确保 App 符合 App Store 的要求。它利用 [App Store Privacy Manifest Analyzer](https://github.com/crasowas/app_store_required_privacy_manifest_analyser) 对 App 及其依赖项进行 API 使用分析,并生成或修复`PrivacyInfo.xcprivacy`文件。
|
||||
|
||||
## ✨ 功能特点
|
||||
|
||||
- **非侵入式集成**:无需修改源码或调整项目结构。
|
||||
- **极速安装与卸载**:一行命令即可快速完成工具的安装或卸载。
|
||||
- **自动分析与修复**:项目构建时自动分析 API 使用情况并修复隐私清单问题。
|
||||
- **灵活定制模板**:支持自定义 App 和 Framework 的隐私清单模板,满足多种使用场景。
|
||||
- **隐私访问报告**:自动生成报告用于查看 App 和 SDK 的`NSPrivacyAccessedAPITypes`声明情况。
|
||||
- **版本轻松升级**:提供升级脚本快速更新至最新版本。
|
||||
|
||||
## 📥 安装
|
||||
|
||||
### 下载工具
|
||||
|
||||
1. 下载[最新发布版本](https://github.com/crasowas/app_privacy_manifest_fixer/releases/latest)。
|
||||
2. 解压下载的文件:
|
||||
- 解压后的目录通常为`app_privacy_manifest_fixer-xxx`(其中`xxx`是版本号)。
|
||||
- 建议重命名为`app_privacy_manifest_fixer`,或在后续路径中使用完整目录名。
|
||||
- **建议将该目录移动至 iOS/macOS 项目中,以避免因路径问题在不同设备上运行时出现错误,同时便于为每个项目单独自定义隐私清单模板**。
|
||||
|
||||
### ⚡ 自动安装(推荐)
|
||||
|
||||
1. **切换到工具所在目录**:
|
||||
|
||||
```shell
|
||||
cd /path/to/app_privacy_manifest_fixer
|
||||
```
|
||||
|
||||
2. **运行以下安装脚本**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path>
|
||||
```
|
||||
|
||||
- 如果是 Flutter 项目,`project_path`应为 Flutter 项目中的`ios/macos`目录路径。
|
||||
- 重复运行安装命令时,工具会先移除现有安装(如果有)。若需修改命令行选项,只需重新运行安装命令,无需先卸载。
|
||||
|
||||
### 手动安装
|
||||
|
||||
如果不使用安装脚本,可以手动添加`Fix Privacy Manifest`任务到 Xcode 的 **Build Phases** 完成安装。安装步骤如下:
|
||||
|
||||
#### 1. 在 Xcode 中添加脚本
|
||||
|
||||
- 用 Xcode 打开你的 iOS/macOS 项目,进入 **TARGETS** 选项卡,选择你的 App 目标。
|
||||
- 进入 **Build Phases**,点击 **+** 按钮,选择 **New Run Script Phase**。
|
||||
- 将新建的 **Run Script** 重命名为`Fix Privacy Manifest`。
|
||||
- 在 Shell 脚本框中添加以下代码:
|
||||
|
||||
```shell
|
||||
# 使用相对路径(推荐):如果`app_privacy_manifest_fixer`在项目目录内
|
||||
"$PROJECT_DIR/path/to/app_privacy_manifest_fixer/fixer.sh"
|
||||
|
||||
# 使用绝对路径:如果`app_privacy_manifest_fixer`不在项目目录内
|
||||
# "/absolute/path/to/app_privacy_manifest_fixer/fixer.sh"
|
||||
```
|
||||
|
||||
**请根据实际情况修改`path/to`或`absolute/path/to`,并确保路径正确。同时,删除或注释掉不适用的行**。
|
||||
|
||||
#### 2. 调整脚本执行顺序
|
||||
|
||||
**将该脚本移动到所有其他 Build Phases 之后,确保隐私清单在所有资源拷贝和编译任务完成后再进行修复**。
|
||||
|
||||
### Build Phases 截图
|
||||
|
||||
下面是自动/手动安装成功后的 Xcode Build Phases 配置截图(未启用任何命令行选项):
|
||||
|
||||

|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
安装后,工具将在每次构建项目时自动运行,构建完成后得到的 App 包已经是修复后的结果。
|
||||
|
||||
如果启用`--install-builds-only`命令行选项安装,工具将仅在安装构建时运行。
|
||||
|
||||
### Xcode Build Log 截图
|
||||
|
||||
下面是项目构建时工具输出的日志截图(默认会存储到`app_privacy_manifest_fixer/Build`目录,除非启用`-s`命令行选项):
|
||||
|
||||

|
||||
|
||||
## 📖 使用方法
|
||||
|
||||
### 命令行选项
|
||||
|
||||
- **强制覆盖现有隐私清单(不推荐)**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path> -f
|
||||
```
|
||||
|
||||
启用`-f`选项后,工具会根据 API 使用分析结果和隐私清单模板生成新的隐私清单,并强制覆盖现有隐私清单。默认情况下(未启用`-f`),工具仅修复缺失的隐私清单。
|
||||
|
||||
- **静默模式**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path> -s
|
||||
```
|
||||
|
||||
启用`-s`选项后,工具将禁用修复时的输出,不再复制构建生成的`*.app`、自动生成隐私访问报告或输出修复日志。默认情况下(未启用`-s`),这些输出存储在`app_privacy_manifest_fixer/Build`目录。
|
||||
|
||||
- **仅在安装构建时运行(推荐)**:
|
||||
|
||||
```shell
|
||||
sh install.sh <project_path> --install-builds-only
|
||||
```
|
||||
|
||||
启用`--install-builds-only`选项后,工具仅在执行安装构建(如 **Archive** 操作)时运行,以优化日常开发时的构建性能。如果你是手动安装的,该命令行选项无效,需要手动勾选 **"For install builds only"** 选项。
|
||||
|
||||
**注意**:如果 iOS/macOS 项目在开发环境构建(生成的 App 包含`*.debug.dylib`文件),工具的 API 使用分析结果可能不准确。
|
||||
|
||||
### 升级工具
|
||||
|
||||
要更新至最新版本,请运行以下命令:
|
||||
|
||||
```shell
|
||||
sh upgrade.sh
|
||||
```
|
||||
|
||||
### 卸载工具
|
||||
|
||||
要快速卸载本工具,请运行以下命令:
|
||||
|
||||
```shell
|
||||
sh uninstall.sh <project_path>
|
||||
```
|
||||
|
||||
### 清理工具生成的文件
|
||||
|
||||
要删除工具生成的文件,请运行以下命令:
|
||||
|
||||
```shell
|
||||
sh clean.sh
|
||||
```
|
||||
|
||||
## 🔥 隐私清单模板
|
||||
|
||||
隐私清单模板存储在[`Templates`](https://github.com/crasowas/app_privacy_manifest_fixer/tree/main/Templates)目录,其中根目录已经包含默认模板。
|
||||
|
||||
**如何为 App 或 SDK 自定义隐私清单?只需使用[自定义模板](#自定义模板)!**
|
||||
|
||||
### 模板类型
|
||||
|
||||
模板分为以下几类:
|
||||
- **AppTemplate.xcprivacy**:App 的隐私清单模板。
|
||||
- **FrameworkTemplate.xcprivacy**:通用的 Framework 隐私清单模板。
|
||||
- **FrameworkName.xcprivacy**:特定的 Framework 隐私清单模板,仅在`Templates/UserTemplates`目录有效。
|
||||
|
||||
### 模板优先级
|
||||
|
||||
对于 App,隐私清单模板的优先级如下:
|
||||
- `Templates/UserTemplates/AppTemplate.xcprivacy` > `Templates/AppTemplate.xcprivacy`
|
||||
|
||||
对于特定的 Framework,隐私清单模板的优先级如下:
|
||||
- `Templates/UserTemplates/FrameworkName.xcprivacy` > `Templates/UserTemplates/FrameworkTemplate.xcprivacy` > `Templates/FrameworkTemplate.xcprivacy`
|
||||
|
||||
### 默认模板
|
||||
|
||||
默认模板位于`Templates`根目录,目前包括以下模板:
|
||||
- `Templates/AppTemplate.xcprivacy`
|
||||
- `Templates/FrameworkTemplate.xcprivacy`
|
||||
|
||||
这些模板将根据 API 使用分析结果进行修改,特别是`NSPrivacyAccessedAPIType`条目将被调整,以生成新的隐私清单用于修复,确保符合 App Store 要求。
|
||||
|
||||
**如果需要调整隐私清单模板,例如以下场景,请避免直接修改默认模板,而是使用自定义模板。如果存在相同名称的自定义模板,它将优先于默认模板用于修复。**
|
||||
- 由于 API 使用分析结果不准确,生成了不合规的隐私清单。
|
||||
- 需要修改模板中声明的理由。
|
||||
- 需要声明收集的数据。
|
||||
|
||||
`AppTemplate.xcprivacy`中隐私访问 API 类别及其对应声明的理由如下:
|
||||
|
||||
| [NSPrivacyAccessedAPIType](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitype) | [NSPrivacyAccessedAPITypeReasons](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitypereasons) |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| NSPrivacyAccessedAPICategoryFileTimestamp | C617.1: Inside app or group container |
|
||||
| NSPrivacyAccessedAPICategorySystemBootTime | 35F9.1: Measure time on-device |
|
||||
| NSPrivacyAccessedAPICategoryDiskSpace | E174.1: Write or delete file on-device |
|
||||
| NSPrivacyAccessedAPICategoryActiveKeyboards | 54BD.1: Customize UI on-device |
|
||||
| NSPrivacyAccessedAPICategoryUserDefaults | CA92.1: Access info from same app |
|
||||
|
||||
`FrameworkTemplate.xcprivacy`中隐私访问 API 类别及其对应声明的理由如下:
|
||||
|
||||
| [NSPrivacyAccessedAPIType](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitype) | [NSPrivacyAccessedAPITypeReasons](https://developer.apple.com/documentation/bundleresources/app-privacy-configuration/nsprivacyaccessedapitypes/nsprivacyaccessedapitypereasons) |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| NSPrivacyAccessedAPICategoryFileTimestamp | 0A2A.1: 3rd-party SDK wrapper on-device |
|
||||
| NSPrivacyAccessedAPICategorySystemBootTime | 35F9.1: Measure time on-device |
|
||||
| NSPrivacyAccessedAPICategoryDiskSpace | E174.1: Write or delete file on-device |
|
||||
| NSPrivacyAccessedAPICategoryActiveKeyboards | 54BD.1: Customize UI on-device |
|
||||
| NSPrivacyAccessedAPICategoryUserDefaults | C56D.1: 3rd-party SDK wrapper on-device |
|
||||
|
||||
### 自定义模板
|
||||
|
||||
要创建自定义模板,请将其放在`Templates/UserTemplates`目录,结构如下:
|
||||
- `Templates/UserTemplates/AppTemplate.xcprivacy`
|
||||
- `Templates/UserTemplates/FrameworkTemplate.xcprivacy`
|
||||
- `Templates/UserTemplates/FrameworkName.xcprivacy`
|
||||
|
||||
在这些模板中,只有`FrameworkTemplate.xcprivacy`会根据 API 使用分析结果对`NSPrivacyAccessedAPIType`条目进行调整,以生成新的隐私清单用于 Framework 修复。其他模板保持不变,将直接用于修复。
|
||||
|
||||
**重要说明:**
|
||||
- 特定的 Framework 模板必须遵循命名规范`FrameworkName.xcprivacy`,其中`FrameworkName`需与 Framework 的名称匹配。例如`Flutter.framework`的模板应命名为`Flutter.xcprivacy`。
|
||||
- 对于 macOS Framework,应遵循命名规范`FrameworkName.Version.xcprivacy`,额外增加版本名称用于区分不同的版本。对于单一版本的 macOS Framework,`Version`通常为`A`。
|
||||
- SDK 的名称可能与 Framework 的名称不完全一致。要确定正确的 Framework 名称,请在构建项目后检查 App 包中的`Frameworks`目录。
|
||||
|
||||
## 📑 隐私访问报告
|
||||
|
||||
默认情况下,工具会自动在每次构建时为原始 App 和修复后的 App 生成隐私访问报告,并存储到`app_privacy_manifest_fixer/Build`目录。
|
||||
|
||||
如果需要手动为特定 App 生成隐私访问报告,请运行以下命令:
|
||||
|
||||
```shell
|
||||
sh Report/report.sh <app_path> <report_output_path>
|
||||
# <app_path>: App路径(例如:/path/to/App.app)
|
||||
# <report_output_path>: 报告文件保存路径(例如:/path/to/report.html)
|
||||
```
|
||||
|
||||
**注意**:工具生成的报告目前仅包含隐私访问部分(`NSPrivacyAccessedAPITypes`),如果想看数据收集部分(`NSPrivacyCollectedDataTypes`)请使用 Xcode 生成`PrivacyReport`。
|
||||
|
||||
### 报告示例截图
|
||||
|
||||
| 原始 App 报告(report-original.html) | 修复后 App 报告(report.html) |
|
||||
|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
|
||||
|  |  |
|
||||
|
||||
## 💡 重要考量
|
||||
|
||||
- 如果最新版本的 SDK 支持隐私清单,请尽可能升级,以避免不必要的风险。
|
||||
- 此工具仅为临时解决方案,不应替代正确的 SDK 管理实践。
|
||||
- 在提交 App 审核之前,请检查隐私清单修复后是否符合最新的 App Store 要求。
|
||||
|
||||
## 🙌 贡献
|
||||
|
||||
欢迎任何形式的贡献,包括代码优化、Bug 修复、文档改进等。请确保遵循项目规范,并保持代码风格一致。感谢你的支持!
|
||||
124
ios/App/app_privacy_manifest_fixer/Report/report-template.html
Normal file
124
ios/App/app_privacy_manifest_fixer/Report/report-template.html
Normal file
@@ -0,0 +1,124 @@
|
||||
<!--
|
||||
Copyright (c) 2024, crasowas.
|
||||
|
||||
Use of this source code is governed by a MIT-style license
|
||||
that can be found in the LICENSE file or at
|
||||
https://opensource.org/licenses/MIT.
|
||||
-->
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Privacy Access Report</title>
|
||||
|
||||
<style>
|
||||
body {
|
||||
font-family: Arial, sans-serif;
|
||||
margin: 20px;
|
||||
color: #333;
|
||||
background-color: #f9f9f9;
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
.card {
|
||||
background-color: #fff;
|
||||
border-radius: 10px;
|
||||
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
|
||||
margin-bottom: 20px;
|
||||
padding: 20px;
|
||||
min-width: 735px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 1.2em;
|
||||
margin: 0 0 15px;
|
||||
padding: 12px 20px;
|
||||
color: #fff;
|
||||
background-color: #5a9e6d;
|
||||
border-radius: 8px;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
h2 .version {
|
||||
font-size: 0.7em;
|
||||
color: #5a9e6d;
|
||||
background: #f1f1f1;
|
||||
padding: 2px 6px;
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
a {
|
||||
text-decoration: none;
|
||||
color: #5a9e6d;
|
||||
background-color: #fcfcfc;
|
||||
padding: 8px 16px;
|
||||
border: 1px solid #5a9e6d;
|
||||
border-radius: 5px;
|
||||
font-size: 0.9em;
|
||||
margin-right: 16px;
|
||||
transition: background-color 0.3s ease, color 0.3s ease;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #fff;
|
||||
background-color: #5a9e6d;
|
||||
}
|
||||
|
||||
a.warning {
|
||||
color: #e0b73c;
|
||||
background-color: #fcfcfc;
|
||||
border: 1px solid #e0b73c;
|
||||
}
|
||||
|
||||
a.warning:hover {
|
||||
color: #fff;
|
||||
background-color: #e0b73c;
|
||||
}
|
||||
|
||||
table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
background-color: #fff;
|
||||
border-radius: 8px;
|
||||
overflow: hidden;
|
||||
margin-top: 20px;
|
||||
}
|
||||
|
||||
th,
|
||||
td {
|
||||
border: 1px solid #ddd;
|
||||
padding: 12px 20px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
th {
|
||||
color: #fff;
|
||||
background-color: #b0b8b1;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
tbody tr:nth-child(odd) {
|
||||
background-color: #f9f9f9;
|
||||
}
|
||||
|
||||
tbody tr:hover {
|
||||
background-color: #f0f0f0;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="card" style="display: flex; justify-content: space-between; align-items: center;">
|
||||
<span>
|
||||
This report was generated using version <strong>{{TOOL_VERSION}}</strong>.
|
||||
</span>
|
||||
<a href="https://github.com/crasowas/app_privacy_manifest_fixer" target="_blank">Like this
|
||||
project? 🌟Star it on GitHub!</a>
|
||||
</div>
|
||||
{{REPORT_CONTENT}}
|
||||
</body>
|
||||
</html>
|
||||
285
ios/App/app_privacy_manifest_fixer/Report/report.sh
Executable file
285
ios/App/app_privacy_manifest_fixer/Report/report.sh
Executable file
@@ -0,0 +1,285 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2024, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
# Absolute path of the script and the tool's root directory
|
||||
script_path="$(realpath "$0")"
|
||||
tool_root_path="$(dirname "$(dirname "$script_path")")"
|
||||
|
||||
# Load common constants and utils
|
||||
source "$tool_root_path/Common/constants.sh"
|
||||
source "$tool_root_path/Common/utils.sh"
|
||||
|
||||
# Path to the app
|
||||
app_path="$1"
|
||||
|
||||
# Check if the app exists
|
||||
if [ ! -d "$app_path" ] || [[ "$app_path" != *.app ]]; then
|
||||
echo "Unable to find the app: $app_path"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if the app is iOS or macOS
|
||||
is_ios_app=true
|
||||
frameworks_dir="$app_path/Frameworks"
|
||||
if [ -d "$app_path/Contents/MacOS" ]; then
|
||||
is_ios_app=false
|
||||
frameworks_dir="$app_path/Contents/Frameworks"
|
||||
fi
|
||||
|
||||
report_output_file="$2"
|
||||
# Additional arguments as template usage records
|
||||
template_usage_records=("${@:2}")
|
||||
|
||||
# Copy report template to output file
|
||||
report_template_file="$tool_root_path/Report/report-template.html"
|
||||
if ! rsync -a "$report_template_file" "$report_output_file"; then
|
||||
echo "Failed to copy the report template to $report_output_file"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Read the current tool's version from the VERSION file
|
||||
tool_version_file="$tool_root_path/VERSION"
|
||||
tool_version="N/A"
|
||||
if [ -f "$tool_version_file" ]; then
|
||||
tool_version="$(cat "$tool_version_file")"
|
||||
fi
|
||||
|
||||
# Initialize report content
|
||||
report_content=""
|
||||
|
||||
# Get the template file used for fixing based on the app or framework name
|
||||
function get_used_template_file() {
|
||||
local name="$1"
|
||||
|
||||
for template_usage_record in "${template_usage_records[@]}"; do
|
||||
if [[ "$template_usage_record" == "$name$DELIMITER"* ]]; then
|
||||
echo "${template_usage_record#*$DELIMITER}"
|
||||
return
|
||||
fi
|
||||
done
|
||||
|
||||
echo ""
|
||||
}
|
||||
|
||||
# Analyze accessed API types and their corresponding reasons
|
||||
function analyze_privacy_accessed_api() {
|
||||
local privacy_manifest_file="$1"
|
||||
local -a results=()
|
||||
|
||||
if [ -f "$privacy_manifest_file" ]; then
|
||||
local api_count=$(xmllint --xpath 'count(//dict/key[text()="NSPrivacyAccessedAPIType"])' "$privacy_manifest_file")
|
||||
|
||||
for ((i=1; i<=api_count; i++)); do
|
||||
local api_type=$(xmllint --xpath "(//dict/key[text()='NSPrivacyAccessedAPIType']/following-sibling::string[1])[$i]/text()" "$privacy_manifest_file" 2>/dev/null)
|
||||
local api_reasons=$(xmllint --xpath "(//dict/key[text()='NSPrivacyAccessedAPITypeReasons']/following-sibling::array[1])[position()=$i]/string/text()" "$privacy_manifest_file" 2>/dev/null | paste -sd "/" -)
|
||||
|
||||
if [ -z "$api_type" ]; then
|
||||
api_type="N/A"
|
||||
fi
|
||||
|
||||
if [ -z "$api_reasons" ]; then
|
||||
api_reasons="N/A"
|
||||
fi
|
||||
|
||||
results+=("$api_type$DELIMITER$api_reasons")
|
||||
done
|
||||
fi
|
||||
|
||||
echo "${results[@]}"
|
||||
}
|
||||
|
||||
# Get the path to the `Info.plist` file for the specified app or framework
|
||||
function get_plist_file() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
local plist_file=""
|
||||
|
||||
if [[ "$path" == *.app ]]; then
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
plist_file="$path/Info.plist"
|
||||
else
|
||||
plist_file="$path/Contents/Info.plist"
|
||||
fi
|
||||
elif [[ "$path" == *.framework ]]; then
|
||||
local framework_path="$(get_framework_path "$path" "$version_path")"
|
||||
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
plist_file="$framework_path/Info.plist"
|
||||
else
|
||||
plist_file="$framework_path/Resources/Info.plist"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "$plist_file"
|
||||
}
|
||||
|
||||
# Add an HTML <div> element with the `card` class
|
||||
function add_html_card_container() {
|
||||
local card="$1"
|
||||
|
||||
report_content="$report_content<div class=\"card\">$card</div>"
|
||||
}
|
||||
|
||||
# Generate an HTML <h2> element
|
||||
function generate_html_header() {
|
||||
local title="$1"
|
||||
local version="$2"
|
||||
|
||||
echo "<h2>$title<span class=\"version\">Version $version</span></h2>"
|
||||
}
|
||||
|
||||
# Generate an HTML <a> element with optional `warning` class
|
||||
function generate_html_anchor() {
|
||||
local text="$1"
|
||||
local href="$2"
|
||||
local warning="$3"
|
||||
|
||||
if [ "$warning" == true ]; then
|
||||
echo "<a class=\"warning\" href=\"$href\">$text</a>"
|
||||
else
|
||||
echo "<a href=\"$href\">$text</a>"
|
||||
fi
|
||||
}
|
||||
|
||||
# Generate an HTML <table> element
|
||||
function generate_html_table() {
|
||||
local thead="$1"
|
||||
local tbody="$2"
|
||||
|
||||
echo "<table>$thead$tbody</table>"
|
||||
}
|
||||
|
||||
# Generate an HTML <thead> element
|
||||
function generate_html_thead() {
|
||||
local ths=("$@")
|
||||
local tr=""
|
||||
|
||||
for th in "${ths[@]}"; do
|
||||
tr="$tr<th>$th</th>"
|
||||
done
|
||||
|
||||
echo "<thead><tr>$tr</tr></thead>"
|
||||
}
|
||||
|
||||
# Generate an HTML <tbody> element
|
||||
function generate_html_tbody() {
|
||||
local trs=("$@")
|
||||
local tbody=""
|
||||
|
||||
for tr in "${trs[@]}"; do
|
||||
tbody="$tbody<tr>"
|
||||
local tds=($(split_string_by_delimiter "$tr"))
|
||||
|
||||
for td in "${tds[@]}"; do
|
||||
tbody="$tbody<td>$td</td>"
|
||||
done
|
||||
|
||||
tbody="$tbody</tr>"
|
||||
done
|
||||
|
||||
echo "<tbody>$tbody</tbody>"
|
||||
}
|
||||
|
||||
# Generate the report content for the specified directory
|
||||
function generate_report_content() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
local privacy_manifest_file=""
|
||||
|
||||
if [[ "$path" == *.app ]]; then
|
||||
# Per the documentation, the privacy manifest should be placed at the root of the app’s bundle for iOS, while for macOS, it should be located in `Contents/Resources/` within the app’s bundle
|
||||
# Reference: https://developer.apple.com/documentation/bundleresources/adding-a-privacy-manifest-to-your-app-or-third-party-sdk#Add-a-privacy-manifest-to-your-app
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
privacy_manifest_file="$path/$PRIVACY_MANIFEST_FILE_NAME"
|
||||
else
|
||||
privacy_manifest_file="$path/Contents/Resources/$PRIVACY_MANIFEST_FILE_NAME"
|
||||
fi
|
||||
else
|
||||
# Per the documentation, the privacy manifest should be placed at the root of the iOS framework, while for a macOS framework with multiple versions, it should be located in the `Resources` directory within the corresponding version
|
||||
# Some SDKs don’t follow the guideline, so we use a search-based approach for now
|
||||
# Reference: https://developer.apple.com/documentation/bundleresources/adding-a-privacy-manifest-to-your-app-or-third-party-sdk#Add-a-privacy-manifest-to-your-framework
|
||||
local framework_path="$(get_framework_path "$path" "$version_path")"
|
||||
local privacy_manifest_files=($(search_privacy_manifest_files "$framework_path"))
|
||||
privacy_manifest_file="$(get_privacy_manifest_file "${privacy_manifest_files[@]}")"
|
||||
fi
|
||||
|
||||
local name="$(basename "$path")"
|
||||
local title="$name"
|
||||
if [ -n "$version_path" ]; then
|
||||
title="$name ($version_path)"
|
||||
fi
|
||||
|
||||
local plist_file="$(get_plist_file "$path" "$version_path")"
|
||||
local version="$(get_plist_version "$plist_file")"
|
||||
local card="$(generate_html_header "$title" "$version")"
|
||||
|
||||
if [ -f "$privacy_manifest_file" ]; then
|
||||
card="$card$(generate_html_anchor "$PRIVACY_MANIFEST_FILE_NAME" "$privacy_manifest_file" false)"
|
||||
|
||||
local used_template_file="$(get_used_template_file "$name$version_path")"
|
||||
|
||||
if [ -f "$used_template_file" ]; then
|
||||
card="$card$(generate_html_anchor "Template Used: $(basename "$used_template_file")" "$used_template_file" false)"
|
||||
fi
|
||||
|
||||
local trs=($(analyze_privacy_accessed_api "$privacy_manifest_file"))
|
||||
|
||||
# Generate table only if the accessed privacy API types array is not empty
|
||||
if [[ ${#trs[@]} -gt 0 ]]; then
|
||||
local thead="$(generate_html_thead "NSPrivacyAccessedAPIType" "NSPrivacyAccessedAPITypeReasons")"
|
||||
local tbody="$(generate_html_tbody "${trs[@]}")"
|
||||
|
||||
card="$card$(generate_html_table "$thead" "$tbody")"
|
||||
fi
|
||||
else
|
||||
card="$card$(generate_html_anchor "Missing Privacy Manifest" "$path" true)"
|
||||
fi
|
||||
|
||||
add_html_card_container "$card"
|
||||
}
|
||||
|
||||
# Generate the report content for app
|
||||
function generate_app_report_content() {
|
||||
generate_report_content "$app_path" ""
|
||||
}
|
||||
|
||||
# Generate the report content for frameworks
|
||||
function generate_frameworks_report_content() {
|
||||
if ! [ -d "$frameworks_dir" ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
for path in "$frameworks_dir"/*; do
|
||||
if [ -d "$path" ]; then
|
||||
local versions_dir="$path/Versions"
|
||||
|
||||
if [ -d "$versions_dir" ]; then
|
||||
for version in $(ls -1 "$versions_dir" | grep -vE '^Current$'); do
|
||||
local version_path="Versions/$version"
|
||||
generate_report_content "$path" "$version_path"
|
||||
done
|
||||
else
|
||||
generate_report_content "$path" ""
|
||||
fi
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
# Generate the final report with all content
|
||||
function generate_final_report() {
|
||||
# Replace placeholders in the template with the tool's version and report content
|
||||
sed -i "" -e "s|{{TOOL_VERSION}}|$tool_version|g" -e "s|{{REPORT_CONTENT}}|${report_content}|g" "$report_output_file"
|
||||
|
||||
echo "Privacy Access Report has been generated: $report_output_file"
|
||||
}
|
||||
|
||||
generate_app_report_content
|
||||
generate_frameworks_report_content
|
||||
generate_final_report
|
||||
@@ -0,0 +1,55 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>NSPrivacyTracking</key>
|
||||
<false/>
|
||||
<key>NSPrivacyTrackingDomains</key>
|
||||
<array/>
|
||||
<key>NSPrivacyCollectedDataTypes</key>
|
||||
<array/>
|
||||
<key>NSPrivacyAccessedAPITypes</key>
|
||||
<array>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryFileTimestamp</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>C617.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategorySystemBootTime</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>35F9.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryDiskSpace</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>E174.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryActiveKeyboards</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>54BD.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryUserDefaults</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>CA92.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
</array>
|
||||
</dict>
|
||||
</plist>
|
||||
@@ -0,0 +1,55 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>NSPrivacyTracking</key>
|
||||
<false/>
|
||||
<key>NSPrivacyTrackingDomains</key>
|
||||
<array/>
|
||||
<key>NSPrivacyCollectedDataTypes</key>
|
||||
<array/>
|
||||
<key>NSPrivacyAccessedAPITypes</key>
|
||||
<array>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryFileTimestamp</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>0A2A.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategorySystemBootTime</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>35F9.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryDiskSpace</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>E174.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryActiveKeyboards</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>54BD.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>NSPrivacyAccessedAPIType</key>
|
||||
<string>NSPrivacyAccessedAPICategoryUserDefaults</string>
|
||||
<key>NSPrivacyAccessedAPITypeReasons</key>
|
||||
<array>
|
||||
<string>C56D.1</string>
|
||||
</array>
|
||||
</dict>
|
||||
</array>
|
||||
</dict>
|
||||
</plist>
|
||||
1
ios/App/app_privacy_manifest_fixer/VERSION
Normal file
1
ios/App/app_privacy_manifest_fixer/VERSION
Normal file
@@ -0,0 +1 @@
|
||||
v1.4.1
|
||||
29
ios/App/app_privacy_manifest_fixer/clean.sh
Executable file
29
ios/App/app_privacy_manifest_fixer/clean.sh
Executable file
@@ -0,0 +1,29 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2025, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
target_paths=("Build")
|
||||
|
||||
echo "Cleaning..."
|
||||
|
||||
deleted_anything=false
|
||||
|
||||
for path in "${target_paths[@]}"; do
|
||||
if [ -e "$path" ]; then
|
||||
echo "Removing $path..."
|
||||
rm -rf "./$path"
|
||||
deleted_anything=true
|
||||
fi
|
||||
done
|
||||
|
||||
if [ "$deleted_anything" == true ]; then
|
||||
echo "Cleanup completed."
|
||||
else
|
||||
echo "Nothing to clean."
|
||||
fi
|
||||
490
ios/App/app_privacy_manifest_fixer/fixer.sh
Executable file
490
ios/App/app_privacy_manifest_fixer/fixer.sh
Executable file
@@ -0,0 +1,490 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2024, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
# Absolute path of the script and the tool's root directory
|
||||
script_path="$(realpath "$0")"
|
||||
tool_root_path="$(dirname "$script_path")"
|
||||
|
||||
# Load common constants and utils
|
||||
source "$tool_root_path/Common/constants.sh"
|
||||
source "$tool_root_path/Common/utils.sh"
|
||||
|
||||
# Force replace the existing privacy manifest when the `-f` option is enabled
|
||||
force=false
|
||||
|
||||
# Enable silent mode to disable build output when the `-s` option is enabled
|
||||
silent=false
|
||||
|
||||
# Parse command-line options
|
||||
while getopts ":fs" opt; do
|
||||
case $opt in
|
||||
f)
|
||||
force=true
|
||||
;;
|
||||
s)
|
||||
silent=true
|
||||
;;
|
||||
\?)
|
||||
echo "Invalid option: -$OPTARG" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
shift $((OPTIND - 1))
|
||||
|
||||
# Path of the app produced by the build process
|
||||
app_path="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"
|
||||
|
||||
# Check if the app exists
|
||||
if [ ! -d "$app_path" ] || [[ "$app_path" != *.app ]]; then
|
||||
echo "Unable to find the app: $app_path"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if the app is iOS or macOS
|
||||
is_ios_app=true
|
||||
frameworks_dir="$app_path/Frameworks"
|
||||
if [ -d "$app_path/Contents/MacOS" ]; then
|
||||
is_ios_app=false
|
||||
frameworks_dir="$app_path/Contents/Frameworks"
|
||||
fi
|
||||
|
||||
# Default template directories
|
||||
templates_dir="$tool_root_path/Templates"
|
||||
user_templates_dir="$tool_root_path/Templates/UserTemplates"
|
||||
|
||||
# Use user-defined app privacy manifest template if it exists, otherwise fallback to default
|
||||
app_template_file="$user_templates_dir/$APP_TEMPLATE_FILE_NAME"
|
||||
if [ ! -f "$app_template_file" ]; then
|
||||
app_template_file="$templates_dir/$APP_TEMPLATE_FILE_NAME"
|
||||
fi
|
||||
|
||||
# Use user-defined framework privacy manifest template if it exists, otherwise fallback to default
|
||||
framework_template_file="$user_templates_dir/$FRAMEWORK_TEMPLATE_FILE_NAME"
|
||||
if [ ! -f "$framework_template_file" ]; then
|
||||
framework_template_file="$templates_dir/$FRAMEWORK_TEMPLATE_FILE_NAME"
|
||||
fi
|
||||
|
||||
# Disable build output in silent mode
|
||||
if [ "$silent" == false ]; then
|
||||
# Script used to generate the privacy access report
|
||||
report_script="$tool_root_path/Report/report.sh"
|
||||
# An array to record template usage for generating the privacy access report
|
||||
template_usage_records=()
|
||||
|
||||
# Build output directory
|
||||
build_dir="$tool_root_path/Build/${PRODUCT_NAME}-${CONFIGURATION}_${MARKETING_VERSION}_${CURRENT_PROJECT_VERSION}_$(date +%Y%m%d%H%M%S)"
|
||||
# Ensure the build directory exists
|
||||
mkdir -p "$build_dir"
|
||||
|
||||
# Redirect both stdout and stderr to a log file while keeping console output
|
||||
exec > >(tee "$build_dir/fix.log") 2>&1
|
||||
fi
|
||||
|
||||
# Get the path to the `Info.plist` file for the specified app or framework
|
||||
function get_plist_file() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
local plist_file=""
|
||||
|
||||
if [[ "$path" == *.app ]]; then
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
plist_file="$path/Info.plist"
|
||||
else
|
||||
plist_file="$path/Contents/Info.plist"
|
||||
fi
|
||||
elif [[ "$path" == *.framework ]]; then
|
||||
local framework_path="$(get_framework_path "$path" "$version_path")"
|
||||
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
plist_file="$framework_path/Info.plist"
|
||||
else
|
||||
plist_file="$framework_path/Resources/Info.plist"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "$plist_file"
|
||||
}
|
||||
|
||||
# Get the path to the executable for the specified app or framework
|
||||
function get_executable_path() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
local executable_path=""
|
||||
|
||||
local plist_file="$(get_plist_file "$path" "$version_path")"
|
||||
local executable_name="$(get_plist_executable "$plist_file")"
|
||||
|
||||
if [[ "$path" == *.app ]]; then
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
executable_path="$path/$executable_name"
|
||||
else
|
||||
executable_path="$path/Contents/MacOS/$executable_name"
|
||||
fi
|
||||
elif [[ "$path" == *.framework ]]; then
|
||||
local framework_path="$(get_framework_path "$path" "$version_path")"
|
||||
executable_path="$framework_path/$executable_name"
|
||||
fi
|
||||
|
||||
echo "$executable_path"
|
||||
}
|
||||
|
||||
# Analyze the specified binary file for API symbols and their categories
|
||||
function analyze_binary_file() {
|
||||
local path="$1"
|
||||
local -a results=()
|
||||
|
||||
# Check if the API symbol exists in the binary file using `nm` and `strings`
|
||||
local nm_output=$(nm "$path" 2>/dev/null | xcrun swift-demangle)
|
||||
local strings_output=$(strings "$path")
|
||||
local combined_output="$nm_output"$'\n'"$strings_output"
|
||||
|
||||
for api_symbol in "${API_SYMBOLS[@]}"; do
|
||||
local substrings=($(split_string_by_delimiter "$api_symbol"))
|
||||
local category=${substrings[0]}
|
||||
local api=${substrings[1]}
|
||||
|
||||
if echo "$combined_output" | grep -E "$api\$" >/dev/null; then
|
||||
local index=-1
|
||||
for ((i=0; i < ${#results[@]}; i++)); do
|
||||
local result="${results[i]}"
|
||||
local result_substrings=($(split_string_by_delimiter "$result"))
|
||||
# If the category matches an existing result, update it
|
||||
if [ "$category" == "${result_substrings[0]}" ]; then
|
||||
index=i
|
||||
results[i]="${result_substrings[0]}$DELIMITER${result_substrings[1]},$api$DELIMITER${result_substrings[2]}"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
# If no matching category found, add a new result
|
||||
if [[ $index -eq -1 ]]; then
|
||||
results+=("$category$DELIMITER$api$DELIMITER$(encode_path "$path")")
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
echo "${results[@]}"
|
||||
}
|
||||
|
||||
# Analyze API usage in a binary file
|
||||
function analyze_api_usage() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
local -a results=()
|
||||
|
||||
local binary_file="$(get_executable_path "$path" "$version_path")"
|
||||
|
||||
if [ -f "$binary_file" ]; then
|
||||
results+=($(analyze_binary_file "$binary_file"))
|
||||
fi
|
||||
|
||||
echo "${results[@]}"
|
||||
}
|
||||
|
||||
|
||||
|
||||
# Get unique categories from analysis results
|
||||
function get_categories() {
|
||||
local results=("$@")
|
||||
local -a categories=()
|
||||
|
||||
for result in "${results[@]}"; do
|
||||
local substrings=($(split_string_by_delimiter "$result"))
|
||||
local category=${substrings[0]}
|
||||
if [[ ! "${categories[@]}" =~ "$category" ]]; then
|
||||
categories+=("$category")
|
||||
fi
|
||||
done
|
||||
|
||||
echo "${categories[@]}"
|
||||
}
|
||||
|
||||
# Get template file for the specified app or framework
|
||||
function get_template_file() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
local template_file=""
|
||||
|
||||
if [[ "$path" == *.app ]]; then
|
||||
template_file="$app_template_file"
|
||||
else
|
||||
# Give priority to the user-defined framework privacy manifest template
|
||||
local dep_name="$(get_dependency_name "$path")"
|
||||
if [ -n "$version_path" ]; then
|
||||
dep_name="$dep_name.$(basename "$version_path")"
|
||||
fi
|
||||
|
||||
local dep_template_file="$user_templates_dir/${dep_name}.xcprivacy"
|
||||
if [ -f "$dep_template_file" ]; then
|
||||
template_file="$dep_template_file"
|
||||
else
|
||||
template_file="$framework_template_file"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "$template_file"
|
||||
}
|
||||
|
||||
# Check if the specified template file should be modified
|
||||
#
|
||||
# The following template files will be modified based on analysis:
|
||||
# * Templates/AppTemplate.xcprivacy
|
||||
# * Templates/FrameworkTemplate.xcprivacy
|
||||
# * Templates/UserTemplates/FrameworkTemplate.xcprivacy
|
||||
function is_template_modifiable() {
|
||||
local template_file="$1"
|
||||
|
||||
local template_file_name="$(basename "$template_file")"
|
||||
|
||||
if [[ "$template_file" != "$user_templates_dir"* ]] || [ "$template_file_name" == "$FRAMEWORK_TEMPLATE_FILE_NAME" ]; then
|
||||
return 0
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
# Check if `Hardened Runtime` is enabled for the specified path
|
||||
function is_hardened_runtime_enabled() {
|
||||
local path="$1"
|
||||
|
||||
# Check environment variable first
|
||||
if [ "${ENABLE_HARDENED_RUNTIME:-}" == "YES" ]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Check the code signature flags if environment variable is not set
|
||||
local flags=$(codesign -dvvv "$path" 2>&1 | grep "flags=")
|
||||
if echo "$flags" | grep -q "runtime"; then
|
||||
return 0
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
# Re-sign the target app or framework if code signing is enabled
|
||||
function resign() {
|
||||
local path="$1"
|
||||
|
||||
if [ -n "${EXPANDED_CODE_SIGN_IDENTITY:-}" ] && [ "${CODE_SIGNING_REQUIRED:-}" != "NO" ] && [ "${CODE_SIGNING_ALLOWED:-}" != "NO" ]; then
|
||||
echo "Re-signing $path with Identity ${EXPANDED_CODE_SIGN_IDENTITY_NAME:-$EXPANDED_CODE_SIGN_IDENTITY}"
|
||||
|
||||
local codesign_cmd="/usr/bin/codesign --force --sign ${EXPANDED_CODE_SIGN_IDENTITY} ${OTHER_CODE_SIGN_FLAGS:-} --preserve-metadata=identifier,entitlements"
|
||||
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
$codesign_cmd "$path"
|
||||
else
|
||||
if is_hardened_runtime_enabled "$path"; then
|
||||
codesign_cmd="$codesign_cmd -o runtime"
|
||||
fi
|
||||
|
||||
if [ -d "$path/Contents/MacOS" ]; then
|
||||
find "$path/Contents/MacOS" -type f -name "*.dylib" | while read -r dylib_file; do
|
||||
$codesign_cmd "$dylib_file"
|
||||
done
|
||||
fi
|
||||
|
||||
$codesign_cmd "$path"
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
# Fix the privacy manifest for the app or specified framework
|
||||
# To accelerate the build, existing privacy manifests will be left unchanged unless the `-f` option is enabled
|
||||
# After fixing, the app or framework will be automatically re-signed
|
||||
function fix() {
|
||||
local path="$1"
|
||||
local version_path="$2"
|
||||
local force_resign="$3"
|
||||
local privacy_manifest_file=""
|
||||
|
||||
if [[ "$path" == *.app ]]; then
|
||||
# Per the documentation, the privacy manifest should be placed at the root of the app’s bundle for iOS, while for macOS, it should be located in `Contents/Resources/` within the app’s bundle
|
||||
# Reference: https://developer.apple.com/documentation/bundleresources/adding-a-privacy-manifest-to-your-app-or-third-party-sdk#Add-a-privacy-manifest-to-your-app
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
privacy_manifest_file="$path/$PRIVACY_MANIFEST_FILE_NAME"
|
||||
else
|
||||
privacy_manifest_file="$path/Contents/Resources/$PRIVACY_MANIFEST_FILE_NAME"
|
||||
fi
|
||||
else
|
||||
# Per the documentation, the privacy manifest should be placed at the root of the iOS framework, while for a macOS framework with multiple versions, it should be located in the `Resources` directory within the corresponding version
|
||||
# Some SDKs don’t follow the guideline, so we use a search-based approach for now
|
||||
# Reference: https://developer.apple.com/documentation/bundleresources/adding-a-privacy-manifest-to-your-app-or-third-party-sdk#Add-a-privacy-manifest-to-your-framework
|
||||
local framework_path="$(get_framework_path "$path" "$version_path")"
|
||||
local privacy_manifest_files=($(search_privacy_manifest_files "$framework_path"))
|
||||
privacy_manifest_file="$(get_privacy_manifest_file "${privacy_manifest_files[@]}")"
|
||||
|
||||
if [ -z "$privacy_manifest_file" ]; then
|
||||
if [ "$is_ios_app" == true ]; then
|
||||
privacy_manifest_file="$framework_path/$PRIVACY_MANIFEST_FILE_NAME"
|
||||
else
|
||||
privacy_manifest_file="$framework_path/Resources/$PRIVACY_MANIFEST_FILE_NAME"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
# Check if the privacy manifest file exists
|
||||
if [ -f "$privacy_manifest_file" ]; then
|
||||
echo "💡 Found privacy manifest file: $privacy_manifest_file"
|
||||
|
||||
if [ "$force" == false ]; then
|
||||
if [ "$force_resign" == true ]; then
|
||||
resign "$path"
|
||||
fi
|
||||
echo "✅ Privacy manifest file already exists, skipping fix."
|
||||
return
|
||||
fi
|
||||
else
|
||||
echo "⚠️ Missing privacy manifest file!"
|
||||
fi
|
||||
|
||||
local results=($(analyze_api_usage "$path" "$version_path"))
|
||||
echo "API usage analysis result(s): ${#results[@]}"
|
||||
print_array "${results[@]}"
|
||||
|
||||
local template_file="$(get_template_file "$path" "$version_path")"
|
||||
template_usage_records+=("$(basename "$path")$version_path$DELIMITER$template_file")
|
||||
|
||||
# Copy the template file to the privacy manifest location, overwriting if it exists
|
||||
cp "$template_file" "$privacy_manifest_file"
|
||||
|
||||
if is_template_modifiable "$template_file"; then
|
||||
local categories=($(get_categories "${results[@]}"))
|
||||
local remove_categories=()
|
||||
|
||||
# Check if categories is non-empty
|
||||
if [[ ${#categories[@]} -gt 0 ]]; then
|
||||
# Convert categories to a single space-separated string for easy matching
|
||||
local categories_set=" ${categories[*]} "
|
||||
|
||||
# Iterate through each element in `API_CATEGORIES`
|
||||
for element in "${API_CATEGORIES[@]}"; do
|
||||
# If element is not found in `categories_set`, add it to `remove_categories`
|
||||
if [[ ! $categories_set =~ " $element " ]]; then
|
||||
remove_categories+=("$element")
|
||||
fi
|
||||
done
|
||||
else
|
||||
# If categories is empty, add all of `API_CATEGORIES` to `remove_categories`
|
||||
remove_categories=("${API_CATEGORIES[@]}")
|
||||
fi
|
||||
|
||||
# Remove extra spaces in the XML file to simplify node removal
|
||||
xmllint --noblanks "$privacy_manifest_file" -o "$privacy_manifest_file"
|
||||
|
||||
# Build a sed command to remove all matching nodes at once
|
||||
local sed_pattern=""
|
||||
for category in "${remove_categories[@]}"; do
|
||||
# Find the node for the current category
|
||||
local remove_node="$(xmllint --xpath "//dict[string='$category']" "$privacy_manifest_file" 2>/dev/null || true)"
|
||||
|
||||
# If the node is found, escape special characters and append it to the sed pattern
|
||||
if [ -n "$remove_node" ]; then
|
||||
local escaped_node=$(echo "$remove_node" | sed 's/[\/&]/\\&/g')
|
||||
sed_pattern+="s/$escaped_node//g;"
|
||||
fi
|
||||
done
|
||||
|
||||
# Apply the combined sed pattern to the file if it's not empty
|
||||
if [ -n "$sed_pattern" ]; then
|
||||
sed -i "" "$sed_pattern" "$privacy_manifest_file"
|
||||
fi
|
||||
|
||||
# Reformat the XML file to restore spaces for readability
|
||||
xmllint --format "$privacy_manifest_file" -o "$privacy_manifest_file"
|
||||
fi
|
||||
|
||||
resign "$path"
|
||||
|
||||
echo "✅ Privacy manifest file fixed: $privacy_manifest_file."
|
||||
}
|
||||
|
||||
# Fix privacy manifests for all frameworks
|
||||
function fix_frameworks() {
|
||||
if ! [ -d "$frameworks_dir" ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
echo "🛠️ Fixing Frameworks..."
|
||||
for path in "$frameworks_dir"/*; do
|
||||
if [ -d "$path" ]; then
|
||||
local dep_name="$(get_dependency_name "$path")"
|
||||
local versions_dir="$path/Versions"
|
||||
|
||||
if [ -d "$versions_dir" ]; then
|
||||
for version in $(ls -1 "$versions_dir" | grep -vE '^Current$'); do
|
||||
local version_path="Versions/$version"
|
||||
echo "Analyzing $dep_name ($version_path) ..."
|
||||
fix "$path" "$version_path" false
|
||||
echo ""
|
||||
done
|
||||
else
|
||||
echo "Analyzing $dep_name ..."
|
||||
fix "$path" "" false
|
||||
echo ""
|
||||
fi
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
# Fix the privacy manifest for the app
|
||||
function fix_app() {
|
||||
echo "🛠️ Fixing $(basename "$app_path" .app) App..."
|
||||
# Since the framework may have undergone fixes, the app must be forcefully re-signed
|
||||
fix "$app_path" "" true
|
||||
echo ""
|
||||
}
|
||||
|
||||
# Generate the privacy access report for the app
|
||||
function generate_report() {
|
||||
local original="$1"
|
||||
|
||||
if [ "$silent" == true ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
local app_name="$(basename "$app_path")"
|
||||
local name="${app_name%.*}"
|
||||
local report_name=""
|
||||
|
||||
# Adjust output names if the app is flagged as original
|
||||
if [ "$original" == true ]; then
|
||||
app_name="${name}-original.app"
|
||||
report_name="report-original.html"
|
||||
else
|
||||
app_name="$name.app"
|
||||
report_name="report.html"
|
||||
fi
|
||||
|
||||
local target_app_path="$build_dir/$app_name"
|
||||
local report_path="$build_dir/$report_name"
|
||||
|
||||
echo "Copy app to $target_app_path"
|
||||
rsync -a "$app_path/" "$target_app_path/"
|
||||
|
||||
# Generate the privacy access report using the script
|
||||
sh "$report_script" "$target_app_path" "$report_path" "${template_usage_records[@]}"
|
||||
echo ""
|
||||
}
|
||||
|
||||
start_time=$(date +%s)
|
||||
|
||||
generate_report true
|
||||
fix_frameworks
|
||||
fix_app
|
||||
generate_report false
|
||||
|
||||
end_time=$(date +%s)
|
||||
|
||||
echo "🎉 All fixed! ⏰ $((end_time - start_time)) seconds"
|
||||
echo "🌟 If you found this script helpful, please consider giving it a star on GitHub. Your support is appreciated. Thank you!"
|
||||
echo "🔗 Homepage: https://github.com/crasowas/app_privacy_manifest_fixer"
|
||||
echo "🐛 Report issues: https://github.com/crasowas/app_privacy_manifest_fixer/issues"
|
||||
71
ios/App/app_privacy_manifest_fixer/install.sh
Executable file
71
ios/App/app_privacy_manifest_fixer/install.sh
Executable file
@@ -0,0 +1,71 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2024, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
# Check if at least one argument (project_path) is provided
|
||||
if [[ "$#" -lt 1 ]]; then
|
||||
echo "Usage: $0 <project_path> [options...]"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
project_path="$1"
|
||||
|
||||
shift
|
||||
|
||||
options=()
|
||||
install_builds_only=false
|
||||
|
||||
# Check if the `--install-builds-only` option is provided and separate it from other options
|
||||
for arg in "$@"; do
|
||||
if [ "$arg" == "--install-builds-only" ]; then
|
||||
install_builds_only=true
|
||||
else
|
||||
options+=("$arg")
|
||||
fi
|
||||
done
|
||||
|
||||
# Verify Ruby installation
|
||||
if ! command -v ruby &>/dev/null; then
|
||||
echo "Ruby is not installed. Please install Ruby and try again."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if xcodeproj gem is installed
|
||||
if ! gem list -i xcodeproj &>/dev/null; then
|
||||
echo "The 'xcodeproj' gem is not installed."
|
||||
read -p "Would you like to install it now? [Y/n] " response
|
||||
if [[ "$response" =~ ^[Nn]$ ]]; then
|
||||
echo "Please install 'xcodeproj' manually and re-run the script."
|
||||
exit 1
|
||||
fi
|
||||
gem install xcodeproj || { echo "Failed to install 'xcodeproj'."; exit 1; }
|
||||
fi
|
||||
|
||||
# Convert project path to an absolute path if it is relative
|
||||
if [[ ! "$project_path" = /* ]]; then
|
||||
project_path="$(realpath "$project_path")"
|
||||
fi
|
||||
|
||||
# Absolute path of the script and the tool's root directory
|
||||
script_path="$(realpath "$0")"
|
||||
tool_root_path="$(dirname "$script_path")"
|
||||
|
||||
tool_portable_path="$tool_root_path"
|
||||
# If the tool's root directory is inside the project path, make the path portable
|
||||
if [[ "$tool_root_path" == "$project_path"* ]]; then
|
||||
# Extract the path of the tool's root directory relative to the project path
|
||||
tool_relative_path="${tool_root_path#$project_path}"
|
||||
# Formulate a portable path using the `PROJECT_DIR` environment variable provided by Xcode
|
||||
tool_portable_path="\${PROJECT_DIR}${tool_relative_path}"
|
||||
fi
|
||||
|
||||
run_script_content="\"$tool_portable_path/fixer.sh\" ${options[@]}"
|
||||
|
||||
# Execute the Ruby helper script
|
||||
ruby "$tool_root_path/Helper/xcode_install_helper.rb" "$project_path" "$run_script_content" "$install_builds_only"
|
||||
46
ios/App/app_privacy_manifest_fixer/uninstall.sh
Executable file
46
ios/App/app_privacy_manifest_fixer/uninstall.sh
Executable file
@@ -0,0 +1,46 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2024, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
# Check if the project path is provided
|
||||
if [[ $# -eq 0 ]]; then
|
||||
echo "Usage: $0 <project_path>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
project_path="$1"
|
||||
|
||||
# Verify Ruby installation
|
||||
if ! command -v ruby &>/dev/null; then
|
||||
echo "Ruby is not installed. Please install Ruby and try again."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if xcodeproj gem is installed
|
||||
if ! gem list -i xcodeproj &>/dev/null; then
|
||||
echo "The 'xcodeproj' gem is not installed."
|
||||
read -p "Would you like to install it now? [Y/n] " response
|
||||
if [[ "$response" =~ ^[Nn]$ ]]; then
|
||||
echo "Please install 'xcodeproj' manually and re-run the script."
|
||||
exit 1
|
||||
fi
|
||||
gem install xcodeproj || { echo "Failed to install 'xcodeproj'."; exit 1; }
|
||||
fi
|
||||
|
||||
# Convert project path to an absolute path if it is relative
|
||||
if [[ ! "$project_path" = /* ]]; then
|
||||
project_path="$(realpath "$project_path")"
|
||||
fi
|
||||
|
||||
# Absolute path of the script and the tool's root directory
|
||||
script_path="$(realpath "$0")"
|
||||
tool_root_path="$(dirname "$script_path")"
|
||||
|
||||
# Execute the Ruby helper script
|
||||
ruby "$tool_root_path/Helper/xcode_uninstall_helper.rb" "$project_path"
|
||||
108
ios/App/app_privacy_manifest_fixer/upgrade.sh
Executable file
108
ios/App/app_privacy_manifest_fixer/upgrade.sh
Executable file
@@ -0,0 +1,108 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2024, crasowas.
|
||||
#
|
||||
# Use of this source code is governed by a MIT-style license
|
||||
# that can be found in the LICENSE file or at
|
||||
# https://opensource.org/licenses/MIT.
|
||||
|
||||
set -e
|
||||
|
||||
# Absolute path of the script and the tool's root directory
|
||||
script_path="$(realpath "$0")"
|
||||
tool_root_path="$(dirname "$script_path")"
|
||||
|
||||
# Repository details
|
||||
readonly REPO_OWNER="crasowas"
|
||||
readonly REPO_NAME="app_privacy_manifest_fixer"
|
||||
|
||||
# URL to fetch the latest release information
|
||||
readonly LATEST_RELEASE_URL="https://api.github.com/repos/$REPO_OWNER/$REPO_NAME/releases/latest"
|
||||
|
||||
# Fetch the release information from GitHub API
|
||||
release_info=$(curl -s "$LATEST_RELEASE_URL")
|
||||
|
||||
# Extract the latest release version, download URL, and published time
|
||||
latest_version=$(echo "$release_info" | grep -o '"tag_name": "[^"]*' | sed 's/"tag_name": "//')
|
||||
download_url=$(echo "$release_info" | grep -o '"zipball_url": "[^"]*' | sed 's/"zipball_url": "//')
|
||||
published_time=$(echo "$release_info" | grep -o '"published_at": "[^"]*' | sed 's/"published_at": "//')
|
||||
|
||||
# Ensure the latest version, download URL, and published time are successfully retrieved
|
||||
if [ -z "$latest_version" ] || [ -z "$download_url" ] || [ -z "$published_time" ]; then
|
||||
echo "Unable to fetch the latest release information."
|
||||
echo "Request URL: $LATEST_RELEASE_URL"
|
||||
echo "Response Data: $release_info"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Convert UTC time to local time
|
||||
published_time=$(TZ=UTC date -j -f "%Y-%m-%dT%H:%M:%SZ" "$published_time" +"%s" | xargs -I{} date -j -r {} +"%Y-%m-%d %H:%M:%S %z")
|
||||
|
||||
# Read the current tool's version from the VERSION file
|
||||
tool_version_file="$tool_root_path/VERSION"
|
||||
if [ ! -f "$tool_version_file" ]; then
|
||||
echo "VERSION file not found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
local_version="$(cat "$tool_version_file")"
|
||||
|
||||
# Skip upgrade if the current version is already the latest
|
||||
if [ "$local_version" == "$latest_version" ]; then
|
||||
echo "Version $latest_version • $published_time"
|
||||
echo "Already up-to-date."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Create a temporary directory for downloading the release
|
||||
temp_dir=$(mktemp -d)
|
||||
trap "rm -rf $temp_dir" EXIT
|
||||
|
||||
download_file_name="latest-release.tar.gz"
|
||||
|
||||
# Download the latest release archive
|
||||
echo "Downloading version $latest_version..."
|
||||
curl -L "$download_url" -o "$temp_dir/$download_file_name"
|
||||
|
||||
# Check if the download was successful
|
||||
if [ $? -ne 0 ]; then
|
||||
echo "Download failed, please check your network connection and try again."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Extract the downloaded release archive
|
||||
echo "Extracting files..."
|
||||
tar -xzf "$temp_dir/$download_file_name" -C "$temp_dir"
|
||||
|
||||
# Find the extracted release
|
||||
extracted_release_path=$(find "$temp_dir" -mindepth 1 -maxdepth 1 -type d -name "*$REPO_NAME*" | head -n 1)
|
||||
|
||||
# Verify that an extracted release was found
|
||||
if [ -z "$extracted_release_path" ]; then
|
||||
echo "No extracted release found for the latest version."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
user_templates_dir="$tool_root_path/Templates/UserTemplates"
|
||||
user_templates_backup_dir="$temp_dir/Templates/UserTemplates"
|
||||
|
||||
# Backup the user templates directory if it exists
|
||||
if [ -d "$user_templates_dir" ]; then
|
||||
echo "Backing up user templates..."
|
||||
mkdir -p "$user_templates_backup_dir"
|
||||
rsync -a --exclude='.*' "$user_templates_dir/" "$user_templates_backup_dir/"
|
||||
fi
|
||||
|
||||
# Replace old version files with the new version files
|
||||
echo "Replacing old version files..."
|
||||
rsync -a --delete "$extracted_release_path/" "$tool_root_path/"
|
||||
|
||||
# Restore the user templates from the backup
|
||||
if [ -d "$user_templates_backup_dir" ]; then
|
||||
echo "Restoring user templates..."
|
||||
rsync -a --exclude='.*' "$user_templates_backup_dir/" "$user_templates_dir/"
|
||||
fi
|
||||
|
||||
# Upgrade complete
|
||||
echo "Version $latest_version • $published_time"
|
||||
echo "Upgrade completed successfully!"
|
||||
29
main.js
29
main.js
@@ -1,29 +0,0 @@
|
||||
const { app, BrowserWindow } = require('electron');
|
||||
const path = require('path');
|
||||
|
||||
function createWindow() {
|
||||
const win = new BrowserWindow({
|
||||
width: 1200,
|
||||
height: 800,
|
||||
webPreferences: {
|
||||
nodeIntegration: true,
|
||||
contextIsolation: false
|
||||
}
|
||||
});
|
||||
|
||||
win.loadFile(path.join(__dirname, 'dist-electron/www/index.html'));
|
||||
}
|
||||
|
||||
app.whenReady().then(createWindow);
|
||||
|
||||
app.on('window-all-closed', () => {
|
||||
if (process.platform !== 'darwin') {
|
||||
app.quit();
|
||||
}
|
||||
});
|
||||
|
||||
app.on('activate', () => {
|
||||
if (BrowserWindow.getAllWindows().length === 0) {
|
||||
createWindow();
|
||||
}
|
||||
});
|
||||
12
package-lock.json
generated
12
package-lock.json
generated
@@ -8764,9 +8764,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/@types/node": {
|
||||
"version": "20.17.48",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.48.tgz",
|
||||
"integrity": "sha512-KpSfKOHPsiSC4IkZeu2LsusFwExAIVGkhG1KkbaBMLwau0uMhj0fCrvyg9ddM2sAvd+gtiBJLir4LAw1MNMIaw==",
|
||||
"version": "20.17.50",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.50.tgz",
|
||||
"integrity": "sha512-Mxiq0ULv/zo1OzOhwPqOA13I81CV/W3nvd3ChtQZRT5Cwz3cr0FKo/wMSsbTqL3EXpaBAEQhva2B8ByRkOIh9A==",
|
||||
"dependencies": {
|
||||
"undici-types": "~6.19.2"
|
||||
}
|
||||
@@ -27594,9 +27594,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/zod": {
|
||||
"version": "3.25.7",
|
||||
"resolved": "https://registry.npmjs.org/zod/-/zod-3.25.7.tgz",
|
||||
"integrity": "sha512-YGdT1cVRmKkOg6Sq7vY7IkxdphySKnXhaUmFI4r4FcuFVNgpCb9tZfNwXbT6BPjD5oz0nubFsoo9pIqKrDcCvg==",
|
||||
"version": "3.25.12",
|
||||
"resolved": "https://registry.npmjs.org/zod/-/zod-3.25.12.tgz",
|
||||
"integrity": "sha512-A8e9eiwm2L5YEupdjn1YcxL1ZDWuL3Bc4JKvLwUrpKZZtRUDOijR7XXsV5WMuUCZPc1tFYO5yfH14STI08MquA==",
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/colinhacks"
|
||||
}
|
||||
|
||||
@@ -131,7 +131,20 @@ export default class DataExportSection extends Vue {
|
||||
*/
|
||||
public async exportDatabase() {
|
||||
try {
|
||||
const blob = await db.export({ prettyJson: true });
|
||||
const blob = await db.export({
|
||||
prettyJson: true,
|
||||
transform: (table, value, key) => {
|
||||
if (table === "contacts") {
|
||||
// Dexie inserts a number 0 when some are undefined, so we need to totally remove them.
|
||||
Object.keys(value).forEach(prop => {
|
||||
if (value[prop] === undefined) {
|
||||
delete value[prop];
|
||||
}
|
||||
});
|
||||
}
|
||||
return { value, key };
|
||||
},
|
||||
});
|
||||
const fileName = `${db.name}-backup.json`;
|
||||
|
||||
if (this.platformCapabilities.hasFileDownload) {
|
||||
@@ -155,7 +168,7 @@ export default class DataExportSection extends Vue {
|
||||
title: "Export Successful",
|
||||
text: this.platformCapabilities.hasFileDownload
|
||||
? "See your downloads directory for the backup. It is in the Dexie format."
|
||||
: "Please choose a location to save your backup file.",
|
||||
: "You should have been prompted to save your backup file.",
|
||||
},
|
||||
-1,
|
||||
);
|
||||
|
||||
@@ -16,6 +16,36 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- FEEDBACK: Show if camera preview is not visible after mounting -->
|
||||
<div
|
||||
v-if="!showCameraPreview && !blob && isRegistered"
|
||||
class="bg-red-100 text-red-700 border border-red-400 rounded px-4 py-3 my-4 text-sm"
|
||||
>
|
||||
<strong>Camera preview not started.</strong>
|
||||
<div v-if="cameraState === 'off'">
|
||||
<span v-if="platformCapabilities.isMobile">
|
||||
<b>Note:</b> This mobile browser may not support direct camera
|
||||
access, or the app is treating it as a native app.<br />
|
||||
<b>Tip:</b> Try using a desktop browser, or check if your browser
|
||||
supports camera access for web apps.<br />
|
||||
<b>Developer:</b> The platform detection logic may be skipping
|
||||
camera preview for mobile browsers. <br />
|
||||
<b>Action:</b> Review <code>platformCapabilities.isMobile</code> and
|
||||
ensure web browsers on mobile are not treated as native apps.
|
||||
</span>
|
||||
<span v-else>
|
||||
<b>Tip:</b> Your browser supports camera APIs, but the preview did
|
||||
not start. Try refreshing the page or checking browser permissions.
|
||||
</span>
|
||||
</div>
|
||||
<div v-else-if="cameraState === 'error'">
|
||||
<b>Error:</b> {{ error || cameraStateMessage }}
|
||||
</div>
|
||||
<div v-else>
|
||||
<b>Status:</b> {{ cameraStateMessage || "Unknown reason." }}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="mt-4">
|
||||
<template v-if="isRegistered">
|
||||
<div v-if="!blob">
|
||||
@@ -30,6 +60,57 @@
|
||||
v-if="showCameraPreview"
|
||||
class="camera-preview relative flex bg-black overflow-hidden mb-4"
|
||||
>
|
||||
<!-- Diagnostic Panel -->
|
||||
<div
|
||||
v-if="showDiagnostics"
|
||||
class="absolute top-0 left-0 right-0 bg-black/80 text-white text-xs p-2 pt-8 z-20 overflow-auto max-h-[50vh]"
|
||||
>
|
||||
<div class="grid grid-cols-2 gap-2">
|
||||
<div>
|
||||
<p><strong>Camera State:</strong> {{ cameraState }}</p>
|
||||
<p>
|
||||
<strong>State Message:</strong>
|
||||
{{ cameraStateMessage || "None" }}
|
||||
</p>
|
||||
<p><strong>Error:</strong> {{ error || "None" }}</p>
|
||||
<p>
|
||||
<strong>Preview Active:</strong>
|
||||
{{ showCameraPreview ? "Yes" : "No" }}
|
||||
</p>
|
||||
<p>
|
||||
<strong>Stream Active:</strong>
|
||||
{{ !!cameraStream ? "Yes" : "No" }}
|
||||
</p>
|
||||
</div>
|
||||
<div>
|
||||
<p><strong>Browser:</strong> {{ userAgent }}</p>
|
||||
<p>
|
||||
<strong>HTTPS:</strong>
|
||||
{{ isSecureContext ? "Yes" : "No" }}
|
||||
</p>
|
||||
<p>
|
||||
<strong>MediaDevices:</strong>
|
||||
{{ hasMediaDevices ? "Yes" : "No" }}
|
||||
</p>
|
||||
<p>
|
||||
<strong>GetUserMedia:</strong>
|
||||
{{ hasGetUserMedia ? "Yes" : "No" }}
|
||||
</p>
|
||||
<p>
|
||||
<strong>Platform:</strong>
|
||||
{{ platformCapabilities.isMobile ? "Mobile" : "Desktop" }}
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Toggle Diagnostics Button -->
|
||||
<button
|
||||
class="absolute top-2 right-2 bg-black/50 text-white px-2 py-1 rounded text-xs z-30"
|
||||
@click="toggleDiagnostics"
|
||||
>
|
||||
{{ showDiagnostics ? "Hide Diagnostics" : "Show Diagnostics" }}
|
||||
</button>
|
||||
<div class="camera-container w-full h-full relative">
|
||||
<video
|
||||
ref="videoElement"
|
||||
@@ -104,14 +185,14 @@
|
||||
dragMode: 'crop',
|
||||
aspectRatio: 1 / 1,
|
||||
}"
|
||||
class="max-h-[90vh] max-w-[90vw] object-contain"
|
||||
class="max-h-[50vh] max-w-[90vw] object-contain"
|
||||
/>
|
||||
</div>
|
||||
<div v-else>
|
||||
<div class="flex justify-center">
|
||||
<img
|
||||
:src="createBlobURL(blob)"
|
||||
class="mt-2 rounded max-h-[90vh] max-w-[90vw] object-contain"
|
||||
class="mt-2 rounded max-h-[50vh] max-w-[90vw] object-contain"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
@@ -227,12 +308,32 @@ export default class ImageMethodDialog extends Vue {
|
||||
|
||||
private platformCapabilities = this.platformService.getCapabilities();
|
||||
|
||||
// Add diagnostic properties
|
||||
showDiagnostics = false;
|
||||
userAgent = navigator.userAgent;
|
||||
isSecureContext = window.isSecureContext;
|
||||
hasMediaDevices = !!navigator.mediaDevices;
|
||||
hasGetUserMedia = !!(
|
||||
navigator.mediaDevices && navigator.mediaDevices.getUserMedia
|
||||
);
|
||||
cameraState:
|
||||
| "off"
|
||||
| "initializing"
|
||||
| "ready"
|
||||
| "active"
|
||||
| "error"
|
||||
| "permission_denied"
|
||||
| "not_found"
|
||||
| "in_use" = "off";
|
||||
cameraStateMessage?: string;
|
||||
error: string | null = null;
|
||||
|
||||
/**
|
||||
* Lifecycle hook: Initializes component and retrieves user settings
|
||||
* @throws {Error} When settings retrieval fails
|
||||
*/
|
||||
async mounted() {
|
||||
console.log("ImageMethodDialog mounted");
|
||||
logger.log("ImageMethodDialog mounted");
|
||||
try {
|
||||
const settings = await retrieveSettingsForActiveAccount();
|
||||
this.activeDid = settings.activeDid || "";
|
||||
@@ -267,7 +368,7 @@ export default class ImageMethodDialog extends Vue {
|
||||
this.visible = true;
|
||||
|
||||
// Start camera preview immediately if not on mobile
|
||||
if (!this.platformCapabilities.isMobile) {
|
||||
if (!this.platformCapabilities.isNativeApp) {
|
||||
this.startCameraPreview();
|
||||
}
|
||||
}
|
||||
@@ -339,14 +440,23 @@ export default class ImageMethodDialog extends Vue {
|
||||
logger.debug("Current showCameraPreview state:", this.showCameraPreview);
|
||||
logger.debug("Platform capabilities:", this.platformCapabilities);
|
||||
|
||||
if (this.platformCapabilities.isMobile) {
|
||||
if (this.platformCapabilities.isNativeApp) {
|
||||
logger.debug("Using platform service for mobile device");
|
||||
this.cameraState = "initializing";
|
||||
this.cameraStateMessage = "Using platform camera service...";
|
||||
try {
|
||||
const result = await this.platformService.takePicture();
|
||||
this.blob = result.blob;
|
||||
this.fileName = result.fileName;
|
||||
this.cameraState = "ready";
|
||||
this.cameraStateMessage = "Photo captured successfully";
|
||||
} catch (error) {
|
||||
logger.error("Error taking picture:", error);
|
||||
this.cameraState = "error";
|
||||
this.cameraStateMessage =
|
||||
error instanceof Error ? error.message : "Failed to take picture";
|
||||
this.error =
|
||||
error instanceof Error ? error.message : "Failed to take picture";
|
||||
this.$notify(
|
||||
{
|
||||
group: "alert",
|
||||
@@ -362,13 +472,18 @@ export default class ImageMethodDialog extends Vue {
|
||||
|
||||
logger.debug("Starting camera preview for desktop browser");
|
||||
try {
|
||||
this.cameraState = "initializing";
|
||||
this.cameraStateMessage = "Requesting camera access...";
|
||||
this.showCameraPreview = true;
|
||||
await this.$nextTick();
|
||||
|
||||
const stream = await navigator.mediaDevices.getUserMedia({
|
||||
video: { facingMode: "environment" },
|
||||
});
|
||||
logger.debug("Camera access granted");
|
||||
this.cameraStream = stream;
|
||||
this.cameraState = "active";
|
||||
this.cameraStateMessage = "Camera is active";
|
||||
|
||||
await this.$nextTick();
|
||||
|
||||
@@ -385,12 +500,30 @@ export default class ImageMethodDialog extends Vue {
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error("Error starting camera preview:", error);
|
||||
let errorMessage =
|
||||
error instanceof Error ? error.message : "Failed to access camera";
|
||||
if (
|
||||
error.name === "NotReadableError" ||
|
||||
error.name === "TrackStartError"
|
||||
) {
|
||||
errorMessage =
|
||||
"Camera is in use by another application. Please close any other apps or browser tabs using the camera and try again.";
|
||||
} else if (
|
||||
error.name === "NotAllowedError" ||
|
||||
error.name === "PermissionDeniedError"
|
||||
) {
|
||||
errorMessage =
|
||||
"Camera access was denied. Please allow camera access in your browser settings.";
|
||||
}
|
||||
this.cameraState = "error";
|
||||
this.cameraStateMessage = errorMessage;
|
||||
this.error = errorMessage;
|
||||
this.$notify(
|
||||
{
|
||||
group: "alert",
|
||||
type: "danger",
|
||||
title: "Error",
|
||||
text: "Failed to access camera. Please try again.",
|
||||
text: errorMessage,
|
||||
},
|
||||
5000,
|
||||
);
|
||||
@@ -404,6 +537,9 @@ export default class ImageMethodDialog extends Vue {
|
||||
this.cameraStream = null;
|
||||
}
|
||||
this.showCameraPreview = false;
|
||||
this.cameraState = "off";
|
||||
this.cameraStateMessage = "Camera stopped";
|
||||
this.error = null;
|
||||
}
|
||||
|
||||
async capturePhoto() {
|
||||
@@ -449,7 +585,7 @@ export default class ImageMethodDialog extends Vue {
|
||||
|
||||
async retryImage() {
|
||||
this.blob = undefined;
|
||||
if (!this.platformCapabilities.isMobile) {
|
||||
if (!this.platformCapabilities.isNativeApp) {
|
||||
await this.startCameraPreview();
|
||||
}
|
||||
}
|
||||
@@ -533,6 +669,11 @@ export default class ImageMethodDialog extends Vue {
|
||||
this.blob = undefined;
|
||||
}
|
||||
}
|
||||
|
||||
// Add toggle method
|
||||
toggleDiagnostics() {
|
||||
this.showDiagnostics = !this.showDiagnostics;
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
@@ -562,4 +703,11 @@ export default class ImageMethodDialog extends Vue {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
/* Add styles for diagnostic panel */
|
||||
.diagnostic-panel {
|
||||
font-family: monospace;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-all;
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -87,9 +87,79 @@ const DEFAULT_SETTINGS: Settings = {
|
||||
|
||||
// Event handler to initialize the non-sensitive database with default settings
|
||||
db.on("populate", async () => {
|
||||
await db.settings.add(DEFAULT_SETTINGS);
|
||||
try {
|
||||
await db.settings.add(DEFAULT_SETTINGS);
|
||||
} catch (error) {
|
||||
console.error("Error populating the database with default settings:", error);
|
||||
}
|
||||
});
|
||||
|
||||
// Helper function to safely open the database with retries
|
||||
async function safeOpenDatabase(retries = 1, delay = 500): Promise<void> {
|
||||
// console.log("Starting safeOpenDatabase with retries:", retries);
|
||||
for (let i = 0; i < retries; i++) {
|
||||
try {
|
||||
// console.log(`Attempt ${i + 1}: Checking if database is open...`);
|
||||
if (!db.isOpen()) {
|
||||
// console.log(`Attempt ${i + 1}: Database is closed, attempting to open...`);
|
||||
|
||||
// Create a promise that rejects after 5 seconds
|
||||
const timeoutPromise = new Promise((_, reject) => {
|
||||
setTimeout(() => reject(new Error('Database open timed out')), 500);
|
||||
});
|
||||
|
||||
// Race between the open operation and the timeout
|
||||
const openPromise = db.open();
|
||||
// console.log(`Attempt ${i + 1}: Waiting for db.open() promise...`);
|
||||
await Promise.race([openPromise, timeoutPromise]);
|
||||
|
||||
// If we get here, the open succeeded
|
||||
// console.log(`Attempt ${i + 1}: Database opened successfully`);
|
||||
return;
|
||||
}
|
||||
// console.log(`Attempt ${i + 1}: Database was already open`);
|
||||
return;
|
||||
} catch (error) {
|
||||
console.error(`Attempt ${i + 1}: Database open failed:`, error);
|
||||
if (i < retries - 1) {
|
||||
console.log(`Attempt ${i + 1}: Waiting ${delay}ms before retry...`);
|
||||
await new Promise(resolve => setTimeout(resolve, delay));
|
||||
} else {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export async function updateDefaultSettings(
|
||||
settingsChanges: Settings,
|
||||
): Promise<number> {
|
||||
delete settingsChanges.accountDid; // just in case
|
||||
// ensure there is no "id" that would override the key
|
||||
delete settingsChanges.id;
|
||||
try {
|
||||
try {
|
||||
// console.log("Database state before open:", db.isOpen() ? "open" : "closed");
|
||||
// console.log("Database name:", db.name);
|
||||
// console.log("Database version:", db.verno);
|
||||
await safeOpenDatabase();
|
||||
} catch (openError: unknown) {
|
||||
console.error("Failed to open database:", openError);
|
||||
const errorMessage = openError instanceof Error ? openError.message : String(openError);
|
||||
throw new Error(`Database connection failed: ${errorMessage}. Please try again or restart the app.`);
|
||||
}
|
||||
const result = await db.settings.update(MASTER_SETTINGS_KEY, settingsChanges);
|
||||
return result;
|
||||
} catch (error) {
|
||||
console.error("Error updating default settings:", error);
|
||||
if (error instanceof Error) {
|
||||
throw error; // Re-throw if it's already an Error with a message
|
||||
} else {
|
||||
throw new Error(`Failed to update settings: ${error}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Manage the encryption key.
|
||||
|
||||
// It's not really secure to maintain the secret next to the user's data.
|
||||
@@ -183,15 +253,6 @@ export async function retrieveSettingsForActiveAccount(): Promise<Settings> {
|
||||
}
|
||||
}
|
||||
|
||||
export async function updateDefaultSettings(
|
||||
settingsChanges: Settings,
|
||||
): Promise<void> {
|
||||
delete settingsChanges.accountDid; // just in case
|
||||
// ensure there is no "id" that would override the key
|
||||
delete settingsChanges.id;
|
||||
await db.settings.update(MASTER_SETTINGS_KEY, settingsChanges);
|
||||
}
|
||||
|
||||
export async function updateAccountSettings(
|
||||
accountDid: string,
|
||||
settingsChanges: Settings,
|
||||
|
||||
293
src/db/sqlite/init.ts
Normal file
293
src/db/sqlite/init.ts
Normal file
@@ -0,0 +1,293 @@
|
||||
/**
|
||||
* SQLite Database Initialization
|
||||
*
|
||||
* This module handles database initialization, including:
|
||||
* - Database connection management
|
||||
* - Schema creation and migration
|
||||
* - Connection pooling and lifecycle
|
||||
* - Error handling and recovery
|
||||
*/
|
||||
|
||||
import { Database, SQLite3 } from '@wa-sqlite/sql.js';
|
||||
import { DATABASE_SCHEMA, SQLiteTable } from './types';
|
||||
import { logger } from '../../utils/logger';
|
||||
|
||||
// ============================================================================
|
||||
// Database Connection Management
|
||||
// ============================================================================
|
||||
|
||||
export interface DatabaseConnection {
|
||||
db: Database;
|
||||
sqlite3: SQLite3;
|
||||
isOpen: boolean;
|
||||
lastUsed: number;
|
||||
}
|
||||
|
||||
let connection: DatabaseConnection | null = null;
|
||||
const CONNECTION_TIMEOUT = 5 * 60 * 1000; // 5 minutes
|
||||
|
||||
/**
|
||||
* Initialize the SQLite database connection
|
||||
*/
|
||||
export async function initDatabase(): Promise<DatabaseConnection> {
|
||||
if (connection?.isOpen) {
|
||||
connection.lastUsed = Date.now();
|
||||
return connection;
|
||||
}
|
||||
|
||||
try {
|
||||
const sqlite3 = await import('@wa-sqlite/sql.js');
|
||||
const db = await sqlite3.open(':memory:'); // TODO: Configure storage location
|
||||
|
||||
// Enable foreign keys
|
||||
await db.exec('PRAGMA foreign_keys = ON;');
|
||||
|
||||
// Configure for better performance
|
||||
await db.exec(`
|
||||
PRAGMA journal_mode = WAL;
|
||||
PRAGMA synchronous = NORMAL;
|
||||
PRAGMA cache_size = -2000; -- Use 2MB of cache
|
||||
`);
|
||||
|
||||
connection = {
|
||||
db,
|
||||
sqlite3,
|
||||
isOpen: true,
|
||||
lastUsed: Date.now()
|
||||
};
|
||||
|
||||
// Start connection cleanup interval
|
||||
startConnectionCleanup();
|
||||
|
||||
return connection;
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Database initialization failed:', error);
|
||||
throw new Error('Failed to initialize database');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the database connection
|
||||
*/
|
||||
export async function closeDatabase(): Promise<void> {
|
||||
if (!connection?.isOpen) return;
|
||||
|
||||
try {
|
||||
await connection.db.close();
|
||||
connection.isOpen = false;
|
||||
connection = null;
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Database close failed:', error);
|
||||
throw new Error('Failed to close database');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Cleanup inactive connections
|
||||
*/
|
||||
function startConnectionCleanup(): void {
|
||||
setInterval(() => {
|
||||
if (connection && Date.now() - connection.lastUsed > CONNECTION_TIMEOUT) {
|
||||
closeDatabase().catch(error => {
|
||||
logger.error('[SQLite] Connection cleanup failed:', error);
|
||||
});
|
||||
}
|
||||
}, 60000); // Check every minute
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Schema Management
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Create the database schema
|
||||
*/
|
||||
export async function createSchema(): Promise<void> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
try {
|
||||
await db.transaction(async () => {
|
||||
for (const table of DATABASE_SCHEMA) {
|
||||
await createTable(db, table);
|
||||
}
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Schema creation failed:', error);
|
||||
throw new Error('Failed to create database schema');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a single table
|
||||
*/
|
||||
async function createTable(db: Database, table: SQLiteTable): Promise<void> {
|
||||
const columnDefs = table.columns.map(col => {
|
||||
const constraints = [
|
||||
col.primaryKey ? 'PRIMARY KEY' : '',
|
||||
col.unique ? 'UNIQUE' : '',
|
||||
!col.nullable ? 'NOT NULL' : '',
|
||||
col.references ? `REFERENCES ${col.references.table}(${col.references.column})` : '',
|
||||
col.default !== undefined ? `DEFAULT ${formatDefaultValue(col.default)}` : ''
|
||||
].filter(Boolean).join(' ');
|
||||
|
||||
return `${col.name} ${col.type} ${constraints}`.trim();
|
||||
});
|
||||
|
||||
const createTableSQL = `
|
||||
CREATE TABLE IF NOT EXISTS ${table.name} (
|
||||
${columnDefs.join(',\n ')}
|
||||
);
|
||||
`;
|
||||
|
||||
await db.exec(createTableSQL);
|
||||
|
||||
// Create indexes
|
||||
if (table.indexes) {
|
||||
for (const index of table.indexes) {
|
||||
const createIndexSQL = `
|
||||
CREATE INDEX IF NOT EXISTS ${index.name}
|
||||
ON ${table.name} (${index.columns.join(', ')})
|
||||
${index.unique ? 'UNIQUE' : ''};
|
||||
`;
|
||||
await db.exec(createIndexSQL);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Format default value for SQL
|
||||
*/
|
||||
function formatDefaultValue(value: unknown): string {
|
||||
if (value === null) return 'NULL';
|
||||
if (typeof value === 'string') return `'${value.replace(/'/g, "''")}'`;
|
||||
if (typeof value === 'number') return value.toString();
|
||||
if (typeof value === 'boolean') return value ? '1' : '0';
|
||||
throw new Error(`Unsupported default value type: ${typeof value}`);
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Database Health Checks
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Check database health
|
||||
*/
|
||||
export async function checkDatabaseHealth(): Promise<{
|
||||
isHealthy: boolean;
|
||||
tables: string[];
|
||||
error?: string;
|
||||
}> {
|
||||
try {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
// Check if we can query the database
|
||||
const tables = await db.selectAll<{ name: string }>(`
|
||||
SELECT name FROM sqlite_master
|
||||
WHERE type='table' AND name NOT LIKE 'sqlite_%'
|
||||
`);
|
||||
|
||||
return {
|
||||
isHealthy: true,
|
||||
tables: tables.map(t => t.name)
|
||||
};
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Health check failed:', error);
|
||||
return {
|
||||
isHealthy: false,
|
||||
tables: [],
|
||||
error: error instanceof Error ? error.message : 'Unknown error'
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify database integrity
|
||||
*/
|
||||
export async function verifyDatabaseIntegrity(): Promise<{
|
||||
isIntegrityOk: boolean;
|
||||
errors: string[];
|
||||
}> {
|
||||
const { db } = await initDatabase();
|
||||
const errors: string[] = [];
|
||||
|
||||
try {
|
||||
// Run integrity check
|
||||
const result = await db.selectAll<{ integrity_check: string }>('PRAGMA integrity_check;');
|
||||
|
||||
if (result[0]?.integrity_check !== 'ok') {
|
||||
errors.push('Database integrity check failed');
|
||||
}
|
||||
|
||||
// Check foreign key constraints
|
||||
const fkResult = await db.selectAll<{ table: string; rowid: number; parent: string; fkid: number }>(`
|
||||
PRAGMA foreign_key_check;
|
||||
`);
|
||||
|
||||
if (fkResult.length > 0) {
|
||||
errors.push('Foreign key constraint violations found');
|
||||
}
|
||||
|
||||
return {
|
||||
isIntegrityOk: errors.length === 0,
|
||||
errors
|
||||
};
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Integrity check failed:', error);
|
||||
return {
|
||||
isIntegrityOk: false,
|
||||
errors: [error instanceof Error ? error.message : 'Unknown error']
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Database Backup and Recovery
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Create a database backup
|
||||
*/
|
||||
export async function createBackup(): Promise<Uint8Array> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
try {
|
||||
// Export the database to a binary array
|
||||
return await db.export();
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Backup creation failed:', error);
|
||||
throw new Error('Failed to create database backup');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Restore database from backup
|
||||
*/
|
||||
export async function restoreFromBackup(backup: Uint8Array): Promise<void> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
try {
|
||||
// Close current connection
|
||||
await closeDatabase();
|
||||
|
||||
// Create new connection and import backup
|
||||
const sqlite3 = await import('@wa-sqlite/sql.js');
|
||||
const newDb = await sqlite3.open(backup);
|
||||
|
||||
// Verify integrity
|
||||
const { isIntegrityOk, errors } = await verifyDatabaseIntegrity();
|
||||
if (!isIntegrityOk) {
|
||||
throw new Error(`Backup integrity check failed: ${errors.join(', ')}`);
|
||||
}
|
||||
|
||||
// Replace current connection
|
||||
connection = {
|
||||
db: newDb,
|
||||
sqlite3,
|
||||
isOpen: true,
|
||||
lastUsed: Date.now()
|
||||
};
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Backup restoration failed:', error);
|
||||
throw new Error('Failed to restore database from backup');
|
||||
}
|
||||
}
|
||||
374
src/db/sqlite/migration.ts
Normal file
374
src/db/sqlite/migration.ts
Normal file
@@ -0,0 +1,374 @@
|
||||
/**
|
||||
* SQLite Migration Utilities
|
||||
*
|
||||
* This module handles the migration of data from Dexie to SQLite,
|
||||
* including data transformation, validation, and rollback capabilities.
|
||||
*/
|
||||
|
||||
import { Database } from '@wa-sqlite/sql.js';
|
||||
import { initDatabase, createSchema, createBackup } from './init';
|
||||
import {
|
||||
MigrationData,
|
||||
MigrationResult,
|
||||
SQLiteAccount,
|
||||
SQLiteContact,
|
||||
SQLiteContactMethod,
|
||||
SQLiteSettings,
|
||||
SQLiteLog,
|
||||
SQLiteSecret,
|
||||
isSQLiteAccount,
|
||||
isSQLiteContact,
|
||||
isSQLiteSettings
|
||||
} from './types';
|
||||
import { logger } from '../../utils/logger';
|
||||
|
||||
// ============================================================================
|
||||
// Migration Types
|
||||
// ============================================================================
|
||||
|
||||
interface MigrationContext {
|
||||
db: Database;
|
||||
startTime: number;
|
||||
stats: MigrationResult['stats'];
|
||||
errors: Error[];
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Migration Functions
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Migrate data from Dexie to SQLite
|
||||
*/
|
||||
export async function migrateFromDexie(data: MigrationData): Promise<MigrationResult> {
|
||||
const startTime = Date.now();
|
||||
const context: MigrationContext = {
|
||||
db: (await initDatabase()).db,
|
||||
startTime,
|
||||
stats: {
|
||||
accounts: 0,
|
||||
contacts: 0,
|
||||
contactMethods: 0,
|
||||
settings: 0,
|
||||
logs: 0,
|
||||
secrets: 0
|
||||
},
|
||||
errors: []
|
||||
};
|
||||
|
||||
try {
|
||||
// Create backup before migration
|
||||
const backup = await createBackup();
|
||||
|
||||
// Create schema if needed
|
||||
await createSchema();
|
||||
|
||||
// Perform migration in a transaction
|
||||
await context.db.transaction(async () => {
|
||||
// Migrate in order of dependencies
|
||||
await migrateAccounts(context, data.accounts);
|
||||
await migrateContacts(context, data.contacts);
|
||||
await migrateContactMethods(context, data.contactMethods);
|
||||
await migrateSettings(context, data.settings);
|
||||
await migrateLogs(context, data.logs);
|
||||
await migrateSecrets(context, data.secrets);
|
||||
});
|
||||
|
||||
// Verify migration
|
||||
const verificationResult = await verifyMigration(context, data);
|
||||
if (!verificationResult.success) {
|
||||
throw new Error(`Migration verification failed: ${verificationResult.error}`);
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
stats: context.stats,
|
||||
duration: Date.now() - startTime
|
||||
};
|
||||
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Migration failed:', error);
|
||||
|
||||
// Attempt rollback
|
||||
try {
|
||||
await rollbackMigration(backup);
|
||||
} catch (rollbackError) {
|
||||
logger.error('[SQLite] Rollback failed:', rollbackError);
|
||||
context.errors.push(new Error('Migration and rollback failed'));
|
||||
}
|
||||
|
||||
return {
|
||||
success: false,
|
||||
error: error instanceof Error ? error : new Error('Unknown migration error'),
|
||||
stats: context.stats,
|
||||
duration: Date.now() - startTime
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Migration Helpers
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Migrate accounts
|
||||
*/
|
||||
async function migrateAccounts(context: MigrationContext, accounts: SQLiteAccount[]): Promise<void> {
|
||||
for (const account of accounts) {
|
||||
try {
|
||||
if (!isSQLiteAccount(account)) {
|
||||
throw new Error(`Invalid account data: ${JSON.stringify(account)}`);
|
||||
}
|
||||
|
||||
await context.db.exec(`
|
||||
INSERT INTO accounts (
|
||||
did, public_key_hex, created_at, updated_at,
|
||||
identity_json, mnemonic_encrypted, passkey_cred_id_hex, derivation_path
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?)
|
||||
`, [
|
||||
account.did,
|
||||
account.public_key_hex,
|
||||
account.created_at,
|
||||
account.updated_at,
|
||||
account.identity_json || null,
|
||||
account.mnemonic_encrypted || null,
|
||||
account.passkey_cred_id_hex || null,
|
||||
account.derivation_path || null
|
||||
]);
|
||||
|
||||
context.stats.accounts++;
|
||||
} catch (error) {
|
||||
context.errors.push(new Error(`Failed to migrate account ${account.did}: ${error}`));
|
||||
throw error; // Re-throw to trigger transaction rollback
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrate contacts
|
||||
*/
|
||||
async function migrateContacts(context: MigrationContext, contacts: SQLiteContact[]): Promise<void> {
|
||||
for (const contact of contacts) {
|
||||
try {
|
||||
if (!isSQLiteContact(contact)) {
|
||||
throw new Error(`Invalid contact data: ${JSON.stringify(contact)}`);
|
||||
}
|
||||
|
||||
await context.db.exec(`
|
||||
INSERT INTO contacts (
|
||||
id, did, name, notes, profile_image_url,
|
||||
public_key_base64, next_pub_key_hash_b64,
|
||||
sees_me, registered, created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||
`, [
|
||||
contact.id,
|
||||
contact.did,
|
||||
contact.name || null,
|
||||
contact.notes || null,
|
||||
contact.profile_image_url || null,
|
||||
contact.public_key_base64 || null,
|
||||
contact.next_pub_key_hash_b64 || null,
|
||||
contact.sees_me ? 1 : 0,
|
||||
contact.registered ? 1 : 0,
|
||||
contact.created_at,
|
||||
contact.updated_at
|
||||
]);
|
||||
|
||||
context.stats.contacts++;
|
||||
} catch (error) {
|
||||
context.errors.push(new Error(`Failed to migrate contact ${contact.id}: ${error}`));
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrate contact methods
|
||||
*/
|
||||
async function migrateContactMethods(
|
||||
context: MigrationContext,
|
||||
methods: SQLiteContactMethod[]
|
||||
): Promise<void> {
|
||||
for (const method of methods) {
|
||||
try {
|
||||
await context.db.exec(`
|
||||
INSERT INTO contact_methods (
|
||||
id, contact_id, label, type, value,
|
||||
created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?)
|
||||
`, [
|
||||
method.id,
|
||||
method.contact_id,
|
||||
method.label,
|
||||
method.type,
|
||||
method.value,
|
||||
method.created_at,
|
||||
method.updated_at
|
||||
]);
|
||||
|
||||
context.stats.contactMethods++;
|
||||
} catch (error) {
|
||||
context.errors.push(new Error(`Failed to migrate contact method ${method.id}: ${error}`));
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrate settings
|
||||
*/
|
||||
async function migrateSettings(context: MigrationContext, settings: SQLiteSettings[]): Promise<void> {
|
||||
for (const setting of settings) {
|
||||
try {
|
||||
if (!isSQLiteSettings(setting)) {
|
||||
throw new Error(`Invalid settings data: ${JSON.stringify(setting)}`);
|
||||
}
|
||||
|
||||
await context.db.exec(`
|
||||
INSERT INTO settings (
|
||||
key, account_did, value_json, created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?, ?)
|
||||
`, [
|
||||
setting.key,
|
||||
setting.account_did || null,
|
||||
setting.value_json,
|
||||
setting.created_at,
|
||||
setting.updated_at
|
||||
]);
|
||||
|
||||
context.stats.settings++;
|
||||
} catch (error) {
|
||||
context.errors.push(new Error(`Failed to migrate setting ${setting.key}: ${error}`));
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrate logs
|
||||
*/
|
||||
async function migrateLogs(context: MigrationContext, logs: SQLiteLog[]): Promise<void> {
|
||||
for (const log of logs) {
|
||||
try {
|
||||
await context.db.exec(`
|
||||
INSERT INTO logs (
|
||||
id, level, message, metadata_json, created_at
|
||||
) VALUES (?, ?, ?, ?, ?)
|
||||
`, [
|
||||
log.id,
|
||||
log.level,
|
||||
log.message,
|
||||
log.metadata_json || null,
|
||||
log.created_at
|
||||
]);
|
||||
|
||||
context.stats.logs++;
|
||||
} catch (error) {
|
||||
context.errors.push(new Error(`Failed to migrate log ${log.id}: ${error}`));
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrate secrets
|
||||
*/
|
||||
async function migrateSecrets(context: MigrationContext, secrets: SQLiteSecret[]): Promise<void> {
|
||||
for (const secret of secrets) {
|
||||
try {
|
||||
await context.db.exec(`
|
||||
INSERT INTO secrets (
|
||||
key, value_encrypted, created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?)
|
||||
`, [
|
||||
secret.key,
|
||||
secret.value_encrypted,
|
||||
secret.created_at,
|
||||
secret.updated_at
|
||||
]);
|
||||
|
||||
context.stats.secrets++;
|
||||
} catch (error) {
|
||||
context.errors.push(new Error(`Failed to migrate secret ${secret.key}: ${error}`));
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Verification and Rollback
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Verify migration success
|
||||
*/
|
||||
async function verifyMigration(
|
||||
context: MigrationContext,
|
||||
data: MigrationData
|
||||
): Promise<{ success: boolean; error?: string }> {
|
||||
try {
|
||||
// Verify counts
|
||||
const counts = await context.db.selectAll<{ table: string; count: number }>(`
|
||||
SELECT 'accounts' as table, COUNT(*) as count FROM accounts
|
||||
UNION ALL
|
||||
SELECT 'contacts', COUNT(*) FROM contacts
|
||||
UNION ALL
|
||||
SELECT 'contact_methods', COUNT(*) FROM contact_methods
|
||||
UNION ALL
|
||||
SELECT 'settings', COUNT(*) FROM settings
|
||||
UNION ALL
|
||||
SELECT 'logs', COUNT(*) FROM logs
|
||||
UNION ALL
|
||||
SELECT 'secrets', COUNT(*) FROM secrets
|
||||
`);
|
||||
|
||||
const countMap = new Map(counts.map(c => [c.table, c.count]));
|
||||
|
||||
if (countMap.get('accounts') !== data.accounts.length) {
|
||||
return { success: false, error: 'Account count mismatch' };
|
||||
}
|
||||
if (countMap.get('contacts') !== data.contacts.length) {
|
||||
return { success: false, error: 'Contact count mismatch' };
|
||||
}
|
||||
if (countMap.get('contact_methods') !== data.contactMethods.length) {
|
||||
return { success: false, error: 'Contact method count mismatch' };
|
||||
}
|
||||
if (countMap.get('settings') !== data.settings.length) {
|
||||
return { success: false, error: 'Settings count mismatch' };
|
||||
}
|
||||
if (countMap.get('logs') !== data.logs.length) {
|
||||
return { success: false, error: 'Log count mismatch' };
|
||||
}
|
||||
if (countMap.get('secrets') !== data.secrets.length) {
|
||||
return { success: false, error: 'Secret count mismatch' };
|
||||
}
|
||||
|
||||
return { success: true };
|
||||
} catch (error) {
|
||||
return {
|
||||
success: false,
|
||||
error: error instanceof Error ? error.message : 'Unknown verification error'
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Rollback migration
|
||||
*/
|
||||
async function rollbackMigration(backup: Uint8Array): Promise<void> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
try {
|
||||
// Close current connection
|
||||
await db.close();
|
||||
|
||||
// Restore from backup
|
||||
const sqlite3 = await import('@wa-sqlite/sql.js');
|
||||
await sqlite3.open(backup);
|
||||
|
||||
logger.info('[SQLite] Migration rollback successful');
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Migration rollback failed:', error);
|
||||
throw new Error('Failed to rollback migration');
|
||||
}
|
||||
}
|
||||
449
src/db/sqlite/operations.ts
Normal file
449
src/db/sqlite/operations.ts
Normal file
@@ -0,0 +1,449 @@
|
||||
/**
|
||||
* SQLite Database Operations
|
||||
*
|
||||
* This module provides utility functions for common database operations,
|
||||
* including CRUD operations, queries, and transactions.
|
||||
*/
|
||||
|
||||
import { Database } from '@wa-sqlite/sql.js';
|
||||
import { initDatabase } from './init';
|
||||
import {
|
||||
SQLiteAccount,
|
||||
SQLiteContact,
|
||||
SQLiteContactMethod,
|
||||
SQLiteSettings,
|
||||
SQLiteLog,
|
||||
SQLiteSecret,
|
||||
isSQLiteAccount,
|
||||
isSQLiteContact,
|
||||
isSQLiteSettings
|
||||
} from './types';
|
||||
import { logger } from '../../utils/logger';
|
||||
|
||||
// ============================================================================
|
||||
// Transaction Helpers
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Execute a function within a transaction
|
||||
*/
|
||||
export async function withTransaction<T>(
|
||||
operation: (db: Database) => Promise<T>
|
||||
): Promise<T> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
try {
|
||||
return await db.transaction(operation);
|
||||
} catch (error) {
|
||||
logger.error('[SQLite] Transaction failed:', error);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a function with retries
|
||||
*/
|
||||
export async function withRetry<T>(
|
||||
operation: () => Promise<T>,
|
||||
maxRetries = 3,
|
||||
delay = 1000
|
||||
): Promise<T> {
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (let i = 0; i < maxRetries; i++) {
|
||||
try {
|
||||
return await operation();
|
||||
} catch (error) {
|
||||
lastError = error instanceof Error ? error : new Error(String(error));
|
||||
|
||||
if (i < maxRetries - 1) {
|
||||
await new Promise(resolve => setTimeout(resolve, delay * (i + 1)));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
throw lastError;
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Account Operations
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Get account by DID
|
||||
*/
|
||||
export async function getAccountByDid(did: string): Promise<SQLiteAccount | null> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
const accounts = await db.selectAll<SQLiteAccount>(
|
||||
'SELECT * FROM accounts WHERE did = ?',
|
||||
[did]
|
||||
);
|
||||
|
||||
return accounts[0] || null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all accounts
|
||||
*/
|
||||
export async function getAllAccounts(): Promise<SQLiteAccount[]> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
return db.selectAll<SQLiteAccount>(
|
||||
'SELECT * FROM accounts ORDER BY created_at DESC'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create or update account
|
||||
*/
|
||||
export async function upsertAccount(account: SQLiteAccount): Promise<void> {
|
||||
if (!isSQLiteAccount(account)) {
|
||||
throw new Error('Invalid account data');
|
||||
}
|
||||
|
||||
await withTransaction(async (db) => {
|
||||
const existing = await db.selectOne<{ did: string }>(
|
||||
'SELECT did FROM accounts WHERE did = ?',
|
||||
[account.did]
|
||||
);
|
||||
|
||||
if (existing) {
|
||||
await db.exec(`
|
||||
UPDATE accounts SET
|
||||
public_key_hex = ?,
|
||||
updated_at = ?,
|
||||
identity_json = ?,
|
||||
mnemonic_encrypted = ?,
|
||||
passkey_cred_id_hex = ?,
|
||||
derivation_path = ?
|
||||
WHERE did = ?
|
||||
`, [
|
||||
account.public_key_hex,
|
||||
Date.now(),
|
||||
account.identity_json || null,
|
||||
account.mnemonic_encrypted || null,
|
||||
account.passkey_cred_id_hex || null,
|
||||
account.derivation_path || null,
|
||||
account.did
|
||||
]);
|
||||
} else {
|
||||
await db.exec(`
|
||||
INSERT INTO accounts (
|
||||
did, public_key_hex, created_at, updated_at,
|
||||
identity_json, mnemonic_encrypted, passkey_cred_id_hex, derivation_path
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?)
|
||||
`, [
|
||||
account.did,
|
||||
account.public_key_hex,
|
||||
account.created_at,
|
||||
account.updated_at,
|
||||
account.identity_json || null,
|
||||
account.mnemonic_encrypted || null,
|
||||
account.passkey_cred_id_hex || null,
|
||||
account.derivation_path || null
|
||||
]);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Contact Operations
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Get contact by ID
|
||||
*/
|
||||
export async function getContactById(id: string): Promise<SQLiteContact | null> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
const contacts = await db.selectAll<SQLiteContact>(
|
||||
'SELECT * FROM contacts WHERE id = ?',
|
||||
[id]
|
||||
);
|
||||
|
||||
return contacts[0] || null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get contacts by account DID
|
||||
*/
|
||||
export async function getContactsByAccountDid(did: string): Promise<SQLiteContact[]> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
return db.selectAll<SQLiteContact>(
|
||||
'SELECT * FROM contacts WHERE did = ? ORDER BY created_at DESC',
|
||||
[did]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get contact methods for a contact
|
||||
*/
|
||||
export async function getContactMethods(contactId: string): Promise<SQLiteContactMethod[]> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
return db.selectAll<SQLiteContactMethod>(
|
||||
'SELECT * FROM contact_methods WHERE contact_id = ? ORDER BY created_at DESC',
|
||||
[contactId]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create or update contact with methods
|
||||
*/
|
||||
export async function upsertContact(
|
||||
contact: SQLiteContact,
|
||||
methods: SQLiteContactMethod[] = []
|
||||
): Promise<void> {
|
||||
if (!isSQLiteContact(contact)) {
|
||||
throw new Error('Invalid contact data');
|
||||
}
|
||||
|
||||
await withTransaction(async (db) => {
|
||||
const existing = await db.selectOne<{ id: string }>(
|
||||
'SELECT id FROM contacts WHERE id = ?',
|
||||
[contact.id]
|
||||
);
|
||||
|
||||
if (existing) {
|
||||
await db.exec(`
|
||||
UPDATE contacts SET
|
||||
did = ?,
|
||||
name = ?,
|
||||
notes = ?,
|
||||
profile_image_url = ?,
|
||||
public_key_base64 = ?,
|
||||
next_pub_key_hash_b64 = ?,
|
||||
sees_me = ?,
|
||||
registered = ?,
|
||||
updated_at = ?
|
||||
WHERE id = ?
|
||||
`, [
|
||||
contact.did,
|
||||
contact.name || null,
|
||||
contact.notes || null,
|
||||
contact.profile_image_url || null,
|
||||
contact.public_key_base64 || null,
|
||||
contact.next_pub_key_hash_b64 || null,
|
||||
contact.sees_me ? 1 : 0,
|
||||
contact.registered ? 1 : 0,
|
||||
Date.now(),
|
||||
contact.id
|
||||
]);
|
||||
} else {
|
||||
await db.exec(`
|
||||
INSERT INTO contacts (
|
||||
id, did, name, notes, profile_image_url,
|
||||
public_key_base64, next_pub_key_hash_b64,
|
||||
sees_me, registered, created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||
`, [
|
||||
contact.id,
|
||||
contact.did,
|
||||
contact.name || null,
|
||||
contact.notes || null,
|
||||
contact.profile_image_url || null,
|
||||
contact.public_key_base64 || null,
|
||||
contact.next_pub_key_hash_b64 || null,
|
||||
contact.sees_me ? 1 : 0,
|
||||
contact.registered ? 1 : 0,
|
||||
contact.created_at,
|
||||
contact.updated_at
|
||||
]);
|
||||
}
|
||||
|
||||
// Update contact methods
|
||||
if (methods.length > 0) {
|
||||
// Delete existing methods
|
||||
await db.exec(
|
||||
'DELETE FROM contact_methods WHERE contact_id = ?',
|
||||
[contact.id]
|
||||
);
|
||||
|
||||
// Insert new methods
|
||||
for (const method of methods) {
|
||||
await db.exec(`
|
||||
INSERT INTO contact_methods (
|
||||
id, contact_id, label, type, value,
|
||||
created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?)
|
||||
`, [
|
||||
method.id,
|
||||
contact.id,
|
||||
method.label,
|
||||
method.type,
|
||||
method.value,
|
||||
method.created_at,
|
||||
method.updated_at
|
||||
]);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Settings Operations
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Get setting by key
|
||||
*/
|
||||
export async function getSetting(key: string): Promise<SQLiteSettings | null> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
const settings = await db.selectAll<SQLiteSettings>(
|
||||
'SELECT * FROM settings WHERE key = ?',
|
||||
[key]
|
||||
);
|
||||
|
||||
return settings[0] || null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get settings by account DID
|
||||
*/
|
||||
export async function getSettingsByAccountDid(did: string): Promise<SQLiteSettings[]> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
return db.selectAll<SQLiteSettings>(
|
||||
'SELECT * FROM settings WHERE account_did = ? ORDER BY updated_at DESC',
|
||||
[did]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set setting value
|
||||
*/
|
||||
export async function setSetting(setting: SQLiteSettings): Promise<void> {
|
||||
if (!isSQLiteSettings(setting)) {
|
||||
throw new Error('Invalid settings data');
|
||||
}
|
||||
|
||||
await withTransaction(async (db) => {
|
||||
const existing = await db.selectOne<{ key: string }>(
|
||||
'SELECT key FROM settings WHERE key = ?',
|
||||
[setting.key]
|
||||
);
|
||||
|
||||
if (existing) {
|
||||
await db.exec(`
|
||||
UPDATE settings SET
|
||||
account_did = ?,
|
||||
value_json = ?,
|
||||
updated_at = ?
|
||||
WHERE key = ?
|
||||
`, [
|
||||
setting.account_did || null,
|
||||
setting.value_json,
|
||||
Date.now(),
|
||||
setting.key
|
||||
]);
|
||||
} else {
|
||||
await db.exec(`
|
||||
INSERT INTO settings (
|
||||
key, account_did, value_json, created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?, ?)
|
||||
`, [
|
||||
setting.key,
|
||||
setting.account_did || null,
|
||||
setting.value_json,
|
||||
setting.created_at,
|
||||
setting.updated_at
|
||||
]);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Log Operations
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Add log entry
|
||||
*/
|
||||
export async function addLog(log: SQLiteLog): Promise<void> {
|
||||
await withTransaction(async (db) => {
|
||||
await db.exec(`
|
||||
INSERT INTO logs (
|
||||
id, level, message, metadata_json, created_at
|
||||
) VALUES (?, ?, ?, ?, ?)
|
||||
`, [
|
||||
log.id,
|
||||
log.level,
|
||||
log.message,
|
||||
log.metadata_json || null,
|
||||
log.created_at
|
||||
]);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get logs by level
|
||||
*/
|
||||
export async function getLogsByLevel(
|
||||
level: string,
|
||||
limit = 100,
|
||||
offset = 0
|
||||
): Promise<SQLiteLog[]> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
return db.selectAll<SQLiteLog>(
|
||||
'SELECT * FROM logs WHERE level = ? ORDER BY created_at DESC LIMIT ? OFFSET ?',
|
||||
[level, limit, offset]
|
||||
);
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Secret Operations
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Get secret by key
|
||||
*/
|
||||
export async function getSecret(key: string): Promise<SQLiteSecret | null> {
|
||||
const { db } = await initDatabase();
|
||||
|
||||
const secrets = await db.selectAll<SQLiteSecret>(
|
||||
'SELECT * FROM secrets WHERE key = ?',
|
||||
[key]
|
||||
);
|
||||
|
||||
return secrets[0] || null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set secret value
|
||||
*/
|
||||
export async function setSecret(secret: SQLiteSecret): Promise<void> {
|
||||
await withTransaction(async (db) => {
|
||||
const existing = await db.selectOne<{ key: string }>(
|
||||
'SELECT key FROM secrets WHERE key = ?',
|
||||
[secret.key]
|
||||
);
|
||||
|
||||
if (existing) {
|
||||
await db.exec(`
|
||||
UPDATE secrets SET
|
||||
value_encrypted = ?,
|
||||
updated_at = ?
|
||||
WHERE key = ?
|
||||
`, [
|
||||
secret.value_encrypted,
|
||||
Date.now(),
|
||||
secret.key
|
||||
]);
|
||||
} else {
|
||||
await db.exec(`
|
||||
INSERT INTO secrets (
|
||||
key, value_encrypted, created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?)
|
||||
`, [
|
||||
secret.key,
|
||||
secret.value_encrypted,
|
||||
secret.created_at,
|
||||
secret.updated_at
|
||||
]);
|
||||
}
|
||||
});
|
||||
}
|
||||
349
src/db/sqlite/types.ts
Normal file
349
src/db/sqlite/types.ts
Normal file
@@ -0,0 +1,349 @@
|
||||
/**
|
||||
* SQLite Type Definitions
|
||||
*
|
||||
* This file defines the type system for the SQLite implementation,
|
||||
* mapping from the existing Dexie types to SQLite-compatible types.
|
||||
* It includes both the database schema types and the runtime types.
|
||||
*/
|
||||
|
||||
import { SQLiteCompatibleType } from '@jlongster/sql.js';
|
||||
|
||||
// ============================================================================
|
||||
// Base Types and Utilities
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* SQLite column type mapping
|
||||
*/
|
||||
export type SQLiteColumnType =
|
||||
| 'INTEGER' // For numbers, booleans, dates
|
||||
| 'TEXT' // For strings, JSON
|
||||
| 'BLOB' // For binary data
|
||||
| 'REAL' // For floating point numbers
|
||||
| 'NULL'; // For null values
|
||||
|
||||
/**
|
||||
* SQLite column definition
|
||||
*/
|
||||
export interface SQLiteColumn {
|
||||
name: string;
|
||||
type: SQLiteColumnType;
|
||||
nullable?: boolean;
|
||||
primaryKey?: boolean;
|
||||
unique?: boolean;
|
||||
references?: {
|
||||
table: string;
|
||||
column: string;
|
||||
};
|
||||
default?: SQLiteCompatibleType;
|
||||
}
|
||||
|
||||
/**
|
||||
* SQLite table definition
|
||||
*/
|
||||
export interface SQLiteTable {
|
||||
name: string;
|
||||
columns: SQLiteColumn[];
|
||||
indexes?: Array<{
|
||||
name: string;
|
||||
columns: string[];
|
||||
unique?: boolean;
|
||||
}>;
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Account Types
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* SQLite-compatible Account type
|
||||
* Maps from the Dexie Account type
|
||||
*/
|
||||
export interface SQLiteAccount {
|
||||
did: string; // TEXT PRIMARY KEY
|
||||
public_key_hex: string; // TEXT NOT NULL
|
||||
created_at: number; // INTEGER NOT NULL
|
||||
updated_at: number; // INTEGER NOT NULL
|
||||
identity_json?: string; // TEXT (encrypted JSON)
|
||||
mnemonic_encrypted?: string; // TEXT (encrypted)
|
||||
passkey_cred_id_hex?: string; // TEXT
|
||||
derivation_path?: string; // TEXT
|
||||
}
|
||||
|
||||
export const ACCOUNTS_TABLE: SQLiteTable = {
|
||||
name: 'accounts',
|
||||
columns: [
|
||||
{ name: 'did', type: 'TEXT', primaryKey: true },
|
||||
{ name: 'public_key_hex', type: 'TEXT', nullable: false },
|
||||
{ name: 'created_at', type: 'INTEGER', nullable: false },
|
||||
{ name: 'updated_at', type: 'INTEGER', nullable: false },
|
||||
{ name: 'identity_json', type: 'TEXT' },
|
||||
{ name: 'mnemonic_encrypted', type: 'TEXT' },
|
||||
{ name: 'passkey_cred_id_hex', type: 'TEXT' },
|
||||
{ name: 'derivation_path', type: 'TEXT' }
|
||||
],
|
||||
indexes: [
|
||||
{ name: 'idx_accounts_created_at', columns: ['created_at'] },
|
||||
{ name: 'idx_accounts_updated_at', columns: ['updated_at'] }
|
||||
]
|
||||
};
|
||||
|
||||
// ============================================================================
|
||||
// Contact Types
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* SQLite-compatible ContactMethod type
|
||||
*/
|
||||
export interface SQLiteContactMethod {
|
||||
id: string; // TEXT PRIMARY KEY
|
||||
contact_id: string; // TEXT NOT NULL
|
||||
label: string; // TEXT NOT NULL
|
||||
type: string; // TEXT NOT NULL
|
||||
value: string; // TEXT NOT NULL
|
||||
created_at: number; // INTEGER NOT NULL
|
||||
updated_at: number; // INTEGER NOT NULL
|
||||
}
|
||||
|
||||
/**
|
||||
* SQLite-compatible Contact type
|
||||
*/
|
||||
export interface SQLiteContact {
|
||||
id: string; // TEXT PRIMARY KEY
|
||||
did: string; // TEXT NOT NULL
|
||||
name?: string; // TEXT
|
||||
notes?: string; // TEXT
|
||||
profile_image_url?: string; // TEXT
|
||||
public_key_base64?: string; // TEXT
|
||||
next_pub_key_hash_b64?: string; // TEXT
|
||||
sees_me?: boolean; // INTEGER (0 or 1)
|
||||
registered?: boolean; // INTEGER (0 or 1)
|
||||
created_at: number; // INTEGER NOT NULL
|
||||
updated_at: number; // INTEGER NOT NULL
|
||||
}
|
||||
|
||||
export const CONTACTS_TABLE: SQLiteTable = {
|
||||
name: 'contacts',
|
||||
columns: [
|
||||
{ name: 'id', type: 'TEXT', primaryKey: true },
|
||||
{ name: 'did', type: 'TEXT', nullable: false },
|
||||
{ name: 'name', type: 'TEXT' },
|
||||
{ name: 'notes', type: 'TEXT' },
|
||||
{ name: 'profile_image_url', type: 'TEXT' },
|
||||
{ name: 'public_key_base64', type: 'TEXT' },
|
||||
{ name: 'next_pub_key_hash_b64', type: 'TEXT' },
|
||||
{ name: 'sees_me', type: 'INTEGER' },
|
||||
{ name: 'registered', type: 'INTEGER' },
|
||||
{ name: 'created_at', type: 'INTEGER', nullable: false },
|
||||
{ name: 'updated_at', type: 'INTEGER', nullable: false }
|
||||
],
|
||||
indexes: [
|
||||
{ name: 'idx_contacts_did', columns: ['did'] },
|
||||
{ name: 'idx_contacts_created_at', columns: ['created_at'] }
|
||||
]
|
||||
};
|
||||
|
||||
export const CONTACT_METHODS_TABLE: SQLiteTable = {
|
||||
name: 'contact_methods',
|
||||
columns: [
|
||||
{ name: 'id', type: 'TEXT', primaryKey: true },
|
||||
{ name: 'contact_id', type: 'TEXT', nullable: false,
|
||||
references: { table: 'contacts', column: 'id' } },
|
||||
{ name: 'label', type: 'TEXT', nullable: false },
|
||||
{ name: 'type', type: 'TEXT', nullable: false },
|
||||
{ name: 'value', type: 'TEXT', nullable: false },
|
||||
{ name: 'created_at', type: 'INTEGER', nullable: false },
|
||||
{ name: 'updated_at', type: 'INTEGER', nullable: false }
|
||||
],
|
||||
indexes: [
|
||||
{ name: 'idx_contact_methods_contact_id', columns: ['contact_id'] }
|
||||
]
|
||||
};
|
||||
|
||||
// ============================================================================
|
||||
// Settings Types
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* SQLite-compatible Settings type
|
||||
*/
|
||||
export interface SQLiteSettings {
|
||||
key: string; // TEXT PRIMARY KEY
|
||||
account_did?: string; // TEXT
|
||||
value_json: string; // TEXT NOT NULL (JSON stringified)
|
||||
created_at: number; // INTEGER NOT NULL
|
||||
updated_at: number; // INTEGER NOT NULL
|
||||
}
|
||||
|
||||
export const SETTINGS_TABLE: SQLiteTable = {
|
||||
name: 'settings',
|
||||
columns: [
|
||||
{ name: 'key', type: 'TEXT', primaryKey: true },
|
||||
{ name: 'account_did', type: 'TEXT' },
|
||||
{ name: 'value_json', type: 'TEXT', nullable: false },
|
||||
{ name: 'created_at', type: 'INTEGER', nullable: false },
|
||||
{ name: 'updated_at', type: 'INTEGER', nullable: false }
|
||||
],
|
||||
indexes: [
|
||||
{ name: 'idx_settings_account_did', columns: ['account_did'] },
|
||||
{ name: 'idx_settings_updated_at', columns: ['updated_at'] }
|
||||
]
|
||||
};
|
||||
|
||||
// ============================================================================
|
||||
// Log Types
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* SQLite-compatible Log type
|
||||
*/
|
||||
export interface SQLiteLog {
|
||||
id: string; // TEXT PRIMARY KEY
|
||||
level: string; // TEXT NOT NULL
|
||||
message: string; // TEXT NOT NULL
|
||||
metadata_json?: string; // TEXT (JSON stringified)
|
||||
created_at: number; // INTEGER NOT NULL
|
||||
}
|
||||
|
||||
export const LOGS_TABLE: SQLiteTable = {
|
||||
name: 'logs',
|
||||
columns: [
|
||||
{ name: 'id', type: 'TEXT', primaryKey: true },
|
||||
{ name: 'level', type: 'TEXT', nullable: false },
|
||||
{ name: 'message', type: 'TEXT', nullable: false },
|
||||
{ name: 'metadata_json', type: 'TEXT' },
|
||||
{ name: 'created_at', type: 'INTEGER', nullable: false }
|
||||
],
|
||||
indexes: [
|
||||
{ name: 'idx_logs_level', columns: ['level'] },
|
||||
{ name: 'idx_logs_created_at', columns: ['created_at'] }
|
||||
]
|
||||
};
|
||||
|
||||
// ============================================================================
|
||||
// Secret Types
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* SQLite-compatible Secret type
|
||||
* Note: This table should be encrypted at the database level
|
||||
*/
|
||||
export interface SQLiteSecret {
|
||||
key: string; // TEXT PRIMARY KEY
|
||||
value_encrypted: string; // TEXT NOT NULL (encrypted)
|
||||
created_at: number; // INTEGER NOT NULL
|
||||
updated_at: number; // INTEGER NOT NULL
|
||||
}
|
||||
|
||||
export const SECRETS_TABLE: SQLiteTable = {
|
||||
name: 'secrets',
|
||||
columns: [
|
||||
{ name: 'key', type: 'TEXT', primaryKey: true },
|
||||
{ name: 'value_encrypted', type: 'TEXT', nullable: false },
|
||||
{ name: 'created_at', type: 'INTEGER', nullable: false },
|
||||
{ name: 'updated_at', type: 'INTEGER', nullable: false }
|
||||
],
|
||||
indexes: [
|
||||
{ name: 'idx_secrets_updated_at', columns: ['updated_at'] }
|
||||
]
|
||||
};
|
||||
|
||||
// ============================================================================
|
||||
// Database Schema
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Complete database schema definition
|
||||
*/
|
||||
export const DATABASE_SCHEMA: SQLiteTable[] = [
|
||||
ACCOUNTS_TABLE,
|
||||
CONTACTS_TABLE,
|
||||
CONTACT_METHODS_TABLE,
|
||||
SETTINGS_TABLE,
|
||||
LOGS_TABLE,
|
||||
SECRETS_TABLE
|
||||
];
|
||||
|
||||
// ============================================================================
|
||||
// Type Guards and Validators
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Type guard for SQLiteAccount
|
||||
*/
|
||||
export function isSQLiteAccount(value: unknown): value is SQLiteAccount {
|
||||
return (
|
||||
typeof value === 'object' &&
|
||||
value !== null &&
|
||||
typeof (value as SQLiteAccount).did === 'string' &&
|
||||
typeof (value as SQLiteAccount).public_key_hex === 'string' &&
|
||||
typeof (value as SQLiteAccount).created_at === 'number' &&
|
||||
typeof (value as SQLiteAccount).updated_at === 'number'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Type guard for SQLiteContact
|
||||
*/
|
||||
export function isSQLiteContact(value: unknown): value is SQLiteContact {
|
||||
return (
|
||||
typeof value === 'object' &&
|
||||
value !== null &&
|
||||
typeof (value as SQLiteContact).id === 'string' &&
|
||||
typeof (value as SQLiteContact).did === 'string' &&
|
||||
typeof (value as SQLiteContact).created_at === 'number' &&
|
||||
typeof (value as SQLiteContact).updated_at === 'number'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Type guard for SQLiteSettings
|
||||
*/
|
||||
export function isSQLiteSettings(value: unknown): value is SQLiteSettings {
|
||||
return (
|
||||
typeof value === 'object' &&
|
||||
value !== null &&
|
||||
typeof (value as SQLiteSettings).key === 'string' &&
|
||||
typeof (value as SQLiteSettings).value_json === 'string' &&
|
||||
typeof (value as SQLiteSettings).created_at === 'number' &&
|
||||
typeof (value as SQLiteSettings).updated_at === 'number'
|
||||
);
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Migration Types
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Type for migration data from Dexie to SQLite
|
||||
*/
|
||||
export interface MigrationData {
|
||||
accounts: SQLiteAccount[];
|
||||
contacts: SQLiteContact[];
|
||||
contactMethods: SQLiteContactMethod[];
|
||||
settings: SQLiteSettings[];
|
||||
logs: SQLiteLog[];
|
||||
secrets: SQLiteSecret[];
|
||||
metadata: {
|
||||
version: string;
|
||||
timestamp: number;
|
||||
source: 'dexie';
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Migration result type
|
||||
*/
|
||||
export interface MigrationResult {
|
||||
success: boolean;
|
||||
error?: Error;
|
||||
stats: {
|
||||
accounts: number;
|
||||
contacts: number;
|
||||
contactMethods: number;
|
||||
settings: number;
|
||||
logs: number;
|
||||
secrets: number;
|
||||
};
|
||||
duration: number;
|
||||
}
|
||||
@@ -539,20 +539,23 @@ export const generateSaveAndActivateIdentity = async (): Promise<string> => {
|
||||
const identity = JSON.stringify(newId);
|
||||
|
||||
// one of the few times we use accountsDBPromise directly; try to avoid more usage
|
||||
const accountsDB = await accountsDBPromise;
|
||||
await accountsDB.accounts.add({
|
||||
dateCreated: new Date().toISOString(),
|
||||
derivationPath: derivationPath,
|
||||
did: newId.did,
|
||||
identity: identity,
|
||||
mnemonic: mnemonic,
|
||||
publicKeyHex: newId.keys[0].publicKeyHex,
|
||||
});
|
||||
|
||||
await updateDefaultSettings({ activeDid: newId.did });
|
||||
//console.log("Updated default settings in util");
|
||||
try {
|
||||
const accountsDB = await accountsDBPromise;
|
||||
await accountsDB.accounts.add({
|
||||
dateCreated: new Date().toISOString(),
|
||||
derivationPath: derivationPath,
|
||||
did: newId.did,
|
||||
identity: identity,
|
||||
mnemonic: mnemonic,
|
||||
publicKeyHex: newId.keys[0].publicKeyHex,
|
||||
});
|
||||
|
||||
await updateDefaultSettings({ activeDid: newId.did });
|
||||
} catch (error) {
|
||||
console.error("Failed to update default settings:", error);
|
||||
throw new Error("Failed to set default settings. Please try again or restart the app.");
|
||||
}
|
||||
await updateAccountSettings(newId.did, { isRegistered: false });
|
||||
|
||||
return newId.did;
|
||||
};
|
||||
|
||||
|
||||
215
src/main.ts
215
src/main.ts
@@ -1,215 +0,0 @@
|
||||
import { createPinia } from "pinia";
|
||||
import { App as VueApp, ComponentPublicInstance, createApp } from "vue";
|
||||
import App from "./App.vue";
|
||||
import "./registerServiceWorker";
|
||||
import router from "./router";
|
||||
import axios from "axios";
|
||||
import VueAxios from "vue-axios";
|
||||
import Notifications from "notiwind";
|
||||
import "./assets/styles/tailwind.css";
|
||||
|
||||
import { library } from "@fortawesome/fontawesome-svg-core";
|
||||
import {
|
||||
faArrowDown,
|
||||
faArrowLeft,
|
||||
faArrowRight,
|
||||
faArrowRotateBackward,
|
||||
faArrowUpRightFromSquare,
|
||||
faArrowUp,
|
||||
faBan,
|
||||
faBitcoinSign,
|
||||
faBurst,
|
||||
faCalendar,
|
||||
faCamera,
|
||||
faCameraRotate,
|
||||
faCaretDown,
|
||||
faChair,
|
||||
faCheck,
|
||||
faChevronDown,
|
||||
faChevronLeft,
|
||||
faChevronRight,
|
||||
faChevronUp,
|
||||
faCircle,
|
||||
faCircleCheck,
|
||||
faCircleInfo,
|
||||
faCircleQuestion,
|
||||
faCircleUser,
|
||||
faClock,
|
||||
faCoins,
|
||||
faComment,
|
||||
faCopy,
|
||||
faDollar,
|
||||
faEllipsis,
|
||||
faEllipsisVertical,
|
||||
faEnvelopeOpenText,
|
||||
faEraser,
|
||||
faEye,
|
||||
faEyeSlash,
|
||||
faFileContract,
|
||||
faFileLines,
|
||||
faFilter,
|
||||
faFloppyDisk,
|
||||
faFolderOpen,
|
||||
faForward,
|
||||
faGift,
|
||||
faGlobe,
|
||||
faHammer,
|
||||
faHand,
|
||||
faHandHoldingDollar,
|
||||
faHandHoldingHeart,
|
||||
faHouseChimney,
|
||||
faImage,
|
||||
faImagePortrait,
|
||||
faLeftRight,
|
||||
faLightbulb,
|
||||
faLink,
|
||||
faLocationDot,
|
||||
faLongArrowAltLeft,
|
||||
faLongArrowAltRight,
|
||||
faMagnifyingGlass,
|
||||
faMessage,
|
||||
faMinus,
|
||||
faPen,
|
||||
faPersonCircleCheck,
|
||||
faPersonCircleQuestion,
|
||||
faPlus,
|
||||
faQuestion,
|
||||
faQrcode,
|
||||
faRightFromBracket,
|
||||
faRotate,
|
||||
faShareNodes,
|
||||
faSpinner,
|
||||
faSquare,
|
||||
faSquareCaretDown,
|
||||
faSquareCaretUp,
|
||||
faSquarePlus,
|
||||
faTrashCan,
|
||||
faTriangleExclamation,
|
||||
faUser,
|
||||
faUsers,
|
||||
faXmark,
|
||||
} from "@fortawesome/free-solid-svg-icons";
|
||||
|
||||
library.add(
|
||||
faArrowDown,
|
||||
faArrowLeft,
|
||||
faArrowRight,
|
||||
faArrowRotateBackward,
|
||||
faArrowUpRightFromSquare,
|
||||
faArrowUp,
|
||||
faBan,
|
||||
faBitcoinSign,
|
||||
faBurst,
|
||||
faCalendar,
|
||||
faCamera,
|
||||
faCameraRotate,
|
||||
faCaretDown,
|
||||
faChair,
|
||||
faCheck,
|
||||
faChevronDown,
|
||||
faChevronLeft,
|
||||
faChevronRight,
|
||||
faChevronUp,
|
||||
faCircle,
|
||||
faCircleCheck,
|
||||
faCircleInfo,
|
||||
faCircleQuestion,
|
||||
faCircleUser,
|
||||
faClock,
|
||||
faCoins,
|
||||
faComment,
|
||||
faCopy,
|
||||
faDollar,
|
||||
faEllipsis,
|
||||
faEllipsisVertical,
|
||||
faEnvelopeOpenText,
|
||||
faEraser,
|
||||
faEye,
|
||||
faEyeSlash,
|
||||
faFileContract,
|
||||
faFileLines,
|
||||
faFilter,
|
||||
faFloppyDisk,
|
||||
faFolderOpen,
|
||||
faForward,
|
||||
faGift,
|
||||
faGlobe,
|
||||
faHammer,
|
||||
faHand,
|
||||
faHandHoldingDollar,
|
||||
faHandHoldingHeart,
|
||||
faHouseChimney,
|
||||
faImage,
|
||||
faImagePortrait,
|
||||
faLeftRight,
|
||||
faLightbulb,
|
||||
faLink,
|
||||
faLocationDot,
|
||||
faLongArrowAltLeft,
|
||||
faLongArrowAltRight,
|
||||
faMagnifyingGlass,
|
||||
faMessage,
|
||||
faMinus,
|
||||
faPen,
|
||||
faPersonCircleCheck,
|
||||
faPersonCircleQuestion,
|
||||
faPlus,
|
||||
faQrcode,
|
||||
faQuestion,
|
||||
faRotate,
|
||||
faRightFromBracket,
|
||||
faShareNodes,
|
||||
faSpinner,
|
||||
faSquare,
|
||||
faSquareCaretDown,
|
||||
faSquareCaretUp,
|
||||
faSquarePlus,
|
||||
faTrashCan,
|
||||
faTriangleExclamation,
|
||||
faUser,
|
||||
faUsers,
|
||||
faXmark,
|
||||
);
|
||||
|
||||
import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
|
||||
import Camera from "simple-vue-camera";
|
||||
import { logger } from "./utils/logger";
|
||||
|
||||
// Can trigger this with a 'throw' inside some top-level function, eg. on the HomeView
|
||||
function setupGlobalErrorHandler(app: VueApp) {
|
||||
// @ts-expect-error 'cause we cannot see why config is not defined
|
||||
app.config.errorHandler = (
|
||||
err: Error,
|
||||
instance: ComponentPublicInstance | null,
|
||||
info: string,
|
||||
) => {
|
||||
logger.error(
|
||||
"Ouch! Global Error Handler.",
|
||||
"Error:",
|
||||
err,
|
||||
"- Error toString:",
|
||||
err.toString(),
|
||||
"- Info:",
|
||||
info,
|
||||
"- Instance:",
|
||||
instance,
|
||||
);
|
||||
// Want to show a nice notiwind notification but can't figure out how.
|
||||
alert(
|
||||
(err.message || "Something bad happened") +
|
||||
" - Try reloading or restarting the app.",
|
||||
);
|
||||
};
|
||||
}
|
||||
|
||||
const app = createApp(App)
|
||||
.component("fa", FontAwesomeIcon)
|
||||
.component("camera", Camera)
|
||||
.use(createPinia())
|
||||
.use(VueAxios, axios)
|
||||
.use(router)
|
||||
.use(Notifications);
|
||||
|
||||
setupGlobalErrorHandler(app);
|
||||
|
||||
app.mount("#app");
|
||||
@@ -88,9 +88,9 @@ const routes: Array<RouteRecordRaw> = [
|
||||
component: () => import("../views/ContactQRScanShowView.vue"),
|
||||
},
|
||||
{
|
||||
path: "/contact-qr-scan",
|
||||
name: "contact-qr-scan",
|
||||
component: () => import("../views/ContactQRScanView.vue"),
|
||||
path: "/contact-qr-scan-full",
|
||||
name: "contact-qr-scan-full",
|
||||
component: () => import("../views/ContactQRScanFullView.vue"),
|
||||
},
|
||||
{
|
||||
path: "/contacts",
|
||||
@@ -243,11 +243,6 @@ const routes: Array<RouteRecordRaw> = [
|
||||
name: "recent-offers-to-user-projects",
|
||||
component: () => import("../views/RecentOffersToUserProjectsView.vue"),
|
||||
},
|
||||
{
|
||||
path: "/scan-contact",
|
||||
name: "scan-contact",
|
||||
component: () => import("../views/ContactScanView.vue"),
|
||||
},
|
||||
{
|
||||
path: "/search-area",
|
||||
name: "search-area",
|
||||
|
||||
@@ -90,16 +90,60 @@ export class WebInlineQRScanner implements QRScannerService {
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Checking camera permissions...`,
|
||||
);
|
||||
const permissions = await navigator.permissions.query({
|
||||
name: "camera" as PermissionName,
|
||||
});
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Permission state:`,
|
||||
permissions.state,
|
||||
);
|
||||
const granted = permissions.state === "granted";
|
||||
this.updateCameraState(granted ? "ready" : "permission_denied");
|
||||
return granted;
|
||||
|
||||
// First try the Permissions API if available
|
||||
if (navigator.permissions && navigator.permissions.query) {
|
||||
try {
|
||||
const permissions = await navigator.permissions.query({
|
||||
name: "camera" as PermissionName,
|
||||
});
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Permission state from Permissions API:`,
|
||||
permissions.state,
|
||||
);
|
||||
if (permissions.state === "granted") {
|
||||
this.updateCameraState("ready", "Camera permissions granted");
|
||||
return true;
|
||||
}
|
||||
} catch (permError) {
|
||||
// Permissions API might not be supported, continue with getUserMedia check
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Permissions API not supported:`,
|
||||
permError,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// If Permissions API is not available or didn't return granted,
|
||||
// try a test getUserMedia call
|
||||
try {
|
||||
const testStream = await navigator.mediaDevices.getUserMedia({
|
||||
video: true,
|
||||
});
|
||||
// If we get here, we have permission
|
||||
testStream.getTracks().forEach((track) => track.stop());
|
||||
this.updateCameraState("ready", "Camera permissions granted");
|
||||
return true;
|
||||
} catch (mediaError) {
|
||||
const error = mediaError as Error;
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] getUserMedia test failed:`,
|
||||
{
|
||||
name: error.name,
|
||||
message: error.message,
|
||||
},
|
||||
);
|
||||
|
||||
if (
|
||||
error.name === "NotAllowedError" ||
|
||||
error.name === "PermissionDeniedError"
|
||||
) {
|
||||
this.updateCameraState("permission_denied", "Camera access denied");
|
||||
return false;
|
||||
}
|
||||
// For other errors, we'll try requesting permissions explicitly
|
||||
return false;
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Error checking camera permissions:`,
|
||||
@@ -122,6 +166,7 @@ export class WebInlineQRScanner implements QRScannerService {
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Requesting camera permissions...`,
|
||||
);
|
||||
|
||||
// First check if we have any video devices
|
||||
const devices = await navigator.mediaDevices.enumerateDevices();
|
||||
const videoDevices = devices.filter(
|
||||
@@ -131,10 +176,12 @@ export class WebInlineQRScanner implements QRScannerService {
|
||||
logger.error(`[WebInlineQRScanner:${this.id}] Found video devices:`, {
|
||||
count: videoDevices.length,
|
||||
devices: videoDevices.map((d) => ({ id: d.deviceId, label: d.label })),
|
||||
userAgent: navigator.userAgent,
|
||||
});
|
||||
|
||||
if (videoDevices.length === 0) {
|
||||
logger.error(`[WebInlineQRScanner:${this.id}] No video devices found`);
|
||||
this.updateCameraState("not_found", "No camera found on this device");
|
||||
throw new Error("No camera found on this device");
|
||||
}
|
||||
|
||||
@@ -148,58 +195,79 @@ export class WebInlineQRScanner implements QRScannerService {
|
||||
},
|
||||
);
|
||||
|
||||
const stream = await navigator.mediaDevices.getUserMedia({
|
||||
video: {
|
||||
facingMode: "environment",
|
||||
width: { ideal: 1280 },
|
||||
height: { ideal: 720 },
|
||||
},
|
||||
});
|
||||
|
||||
this.updateCameraState("ready", "Camera permissions granted");
|
||||
|
||||
// Stop the test stream immediately
|
||||
stream.getTracks().forEach((track) => {
|
||||
logger.error(`[WebInlineQRScanner:${this.id}] Stopping test track:`, {
|
||||
kind: track.kind,
|
||||
label: track.label,
|
||||
readyState: track.readyState,
|
||||
try {
|
||||
const stream = await navigator.mediaDevices.getUserMedia({
|
||||
video: {
|
||||
facingMode: "environment",
|
||||
width: { ideal: 1280 },
|
||||
height: { ideal: 720 },
|
||||
},
|
||||
});
|
||||
track.stop();
|
||||
});
|
||||
return true;
|
||||
|
||||
this.updateCameraState("ready", "Camera permissions granted");
|
||||
|
||||
// Stop the test stream immediately
|
||||
stream.getTracks().forEach((track) => {
|
||||
logger.error(`[WebInlineQRScanner:${this.id}] Stopping test track:`, {
|
||||
kind: track.kind,
|
||||
label: track.label,
|
||||
readyState: track.readyState,
|
||||
});
|
||||
track.stop();
|
||||
});
|
||||
return true;
|
||||
} catch (mediaError) {
|
||||
const error = mediaError as Error;
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Error requesting camera access:`,
|
||||
{
|
||||
name: error.name,
|
||||
message: error.message,
|
||||
userAgent: navigator.userAgent,
|
||||
},
|
||||
);
|
||||
|
||||
// Update state based on error type
|
||||
if (
|
||||
error.name === "NotFoundError" ||
|
||||
error.name === "DevicesNotFoundError"
|
||||
) {
|
||||
this.updateCameraState("not_found", "No camera found on this device");
|
||||
throw new Error("No camera found on this device");
|
||||
} else if (
|
||||
error.name === "NotAllowedError" ||
|
||||
error.name === "PermissionDeniedError"
|
||||
) {
|
||||
this.updateCameraState("permission_denied", "Camera access denied");
|
||||
throw new Error(
|
||||
"Camera access denied. Please grant camera permission and try again",
|
||||
);
|
||||
} else if (
|
||||
error.name === "NotReadableError" ||
|
||||
error.name === "TrackStartError"
|
||||
) {
|
||||
this.updateCameraState(
|
||||
"in_use",
|
||||
"Camera is in use by another application",
|
||||
);
|
||||
throw new Error("Camera is in use by another application");
|
||||
} else {
|
||||
this.updateCameraState("error", error.message);
|
||||
throw new Error(`Camera error: ${error.message}`);
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
const wrappedError =
|
||||
error instanceof Error ? error : new Error(String(error));
|
||||
|
||||
// Update state based on error type
|
||||
if (
|
||||
wrappedError.name === "NotFoundError" ||
|
||||
wrappedError.name === "DevicesNotFoundError"
|
||||
) {
|
||||
this.updateCameraState("not_found", "No camera found on this device");
|
||||
throw new Error("No camera found on this device");
|
||||
} else if (
|
||||
wrappedError.name === "NotAllowedError" ||
|
||||
wrappedError.name === "PermissionDeniedError"
|
||||
) {
|
||||
this.updateCameraState("permission_denied", "Camera access denied");
|
||||
throw new Error(
|
||||
"Camera access denied. Please grant camera permission and try again",
|
||||
);
|
||||
} else if (
|
||||
wrappedError.name === "NotReadableError" ||
|
||||
wrappedError.name === "TrackStartError"
|
||||
) {
|
||||
this.updateCameraState(
|
||||
"in_use",
|
||||
"Camera is in use by another application",
|
||||
);
|
||||
throw new Error("Camera is in use by another application");
|
||||
} else {
|
||||
this.updateCameraState("error", wrappedError.message);
|
||||
throw new Error(`Camera error: ${wrappedError.message}`);
|
||||
}
|
||||
logger.error(
|
||||
`[WebInlineQRScanner:${this.id}] Error in requestPermissions:`,
|
||||
{
|
||||
error: wrappedError.message,
|
||||
stack: wrappedError.stack,
|
||||
userAgent: navigator.userAgent,
|
||||
},
|
||||
);
|
||||
throw wrappedError;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -75,6 +75,9 @@
|
||||
>
|
||||
Set Your Name
|
||||
</button>
|
||||
<p class="text-xs text-slate-500 mt-1">
|
||||
(Don't worry: this is not visible to anyone until you share it with them. It's not sent to any servers.)
|
||||
</p>
|
||||
<UserNameDialog ref="userNameDialog" />
|
||||
</span>
|
||||
<div class="flex justify-center mt-4">
|
||||
@@ -107,24 +110,7 @@
|
||||
<font-awesome icon="camera" class="fa-fw" />
|
||||
</div>
|
||||
</template>
|
||||
<template v-else>
|
||||
<div
|
||||
id="noticeBeforeUpload"
|
||||
class="bg-amber-200 text-amber-900 border-amber-500 border-dashed border text-center rounded-md overflow-hidden px-4 py-3"
|
||||
role="alert"
|
||||
aria-live="polite"
|
||||
>
|
||||
<p class="mb-2">
|
||||
Before you can upload a photo, a friend needs to register you.
|
||||
</p>
|
||||
<router-link
|
||||
:to="{ name: 'contact-qr' }"
|
||||
class="inline-block text-md uppercase bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-4 py-2 rounded-md"
|
||||
>
|
||||
Share Your Info
|
||||
</router-link>
|
||||
</div>
|
||||
</template>
|
||||
<!-- If not registered, they don't need to see this at all. We show a prompt to register below. -->
|
||||
</div>
|
||||
<ImageMethodDialog
|
||||
ref="imageMethodDialog"
|
||||
@@ -217,7 +203,7 @@
|
||||
</p>
|
||||
<router-link
|
||||
:to="{ name: 'contact-qr' }"
|
||||
class="inline-block text-md uppercase bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-4 py-2 rounded-md"
|
||||
class="inline-block text-md bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-4 py-2 rounded-md"
|
||||
>
|
||||
Share Your Info
|
||||
</router-link>
|
||||
@@ -618,6 +604,7 @@
|
||||
leave-to-class="opacity-0"
|
||||
>
|
||||
<div v-if="showContactImport()" class="mt-4">
|
||||
<!-- Bulk import has an error
|
||||
<div class="flex justify-center">
|
||||
<button
|
||||
class="block text-center text-md bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-1.5 py-2 rounded-md mb-6"
|
||||
@@ -628,6 +615,7 @@
|
||||
(which doesn't include Identifier Data)
|
||||
</button>
|
||||
</div>
|
||||
-->
|
||||
<div class="flex justify-center">
|
||||
<button
|
||||
class="block text-center text-md bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-1.5 py-2 rounded-md mb-6"
|
||||
@@ -976,6 +964,7 @@ import { AxiosError } from "axios";
|
||||
import { Buffer } from "buffer/";
|
||||
import Dexie from "dexie";
|
||||
import "dexie-export-import";
|
||||
// @ts-ignore - they aren't exporting it but it's there
|
||||
import { ImportProgress } from "dexie-export-import";
|
||||
import { LeafletMouseEvent } from "leaflet";
|
||||
import * as R from "ramda";
|
||||
@@ -1209,7 +1198,7 @@ export default class AccountViewView extends Vue {
|
||||
title: "Cannot Set Notifications",
|
||||
text: "This browser does not support notifications. Use Chrome, or install this to the home screen, or try other suggestions on the 'Troubleshoot your notifications' page.",
|
||||
},
|
||||
3000,
|
||||
7000,
|
||||
);
|
||||
}
|
||||
this.passkeyExpirationDescription = tokenExpiryTimeDescription();
|
||||
@@ -1621,10 +1610,25 @@ export default class AccountViewView extends Vue {
|
||||
*/
|
||||
async submitImportFile() {
|
||||
if (inputImportFileNameRef.value != null) {
|
||||
await db.delete();
|
||||
await Dexie.import(inputImportFileNameRef.value as Blob, {
|
||||
progressCallback: this.progressCallback,
|
||||
});
|
||||
await db.delete()
|
||||
.then(async () => {
|
||||
// BulkError: settings.bulkAdd(): 1 of 21 operations failed. Errors: ConstraintError: Key already exists in the object store.
|
||||
await Dexie.import(inputImportFileNameRef.value as Blob, {
|
||||
progressCallback: this.progressCallback,
|
||||
})
|
||||
})
|
||||
.catch((error) => {
|
||||
logger.error("Error importing file:", error);
|
||||
this.$notify(
|
||||
{
|
||||
group: "alert",
|
||||
type: "danger",
|
||||
title: "Error Importing",
|
||||
text: "There was an error in the import. Your identities and contacts may have been affected, so you may have to restore your identifier and use the contact import method.",
|
||||
},
|
||||
-1,
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,24 +1,104 @@
|
||||
<template>
|
||||
<!-- CONTENT -->
|
||||
<section id="Content" class="relativew-[100vw] h-[100vh]">
|
||||
<section id="Content" class="relative w-[100vw] h-[100vh]">
|
||||
<div
|
||||
class="absolute inset-x-0 bottom-0 bg-black/50 p-6 pb-[calc(env(safe-area-inset-bottom)+1.5rem)]"
|
||||
class="p-6 bg-white w-full max-w-[calc((100vh-env(safe-area-inset-top)-env(safe-area-inset-bottom))*0.4)] mx-auto"
|
||||
>
|
||||
<p class="text-center text-white mb-3">
|
||||
Point your camera at a TimeSafari contact QR code to scan it
|
||||
automatically.
|
||||
</p>
|
||||
<div class="mb-4">
|
||||
<h1 class="text-xl text-center font-semibold relative">
|
||||
<!-- Back -->
|
||||
<a
|
||||
class="text-lg text-center px-2 py-1 absolute -left-2 -top-1"
|
||||
@click="handleBack"
|
||||
>
|
||||
<font-awesome icon="chevron-left" class="fa-fw" />
|
||||
</a>
|
||||
|
||||
<p v-if="error" class="text-center text-rose-300 mb-3">{{ error }}</p>
|
||||
<!-- Quick Help -->
|
||||
<a
|
||||
class="text-xl text-center text-blue-500 px-2 py-1 absolute -right-2 -top-1"
|
||||
@click="toastQRCodeHelp()"
|
||||
>
|
||||
<font-awesome icon="circle-question" class="fa-fw" />
|
||||
</a>
|
||||
|
||||
<div class="flex justify-center items-center">
|
||||
Share Contact Info
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
<div
|
||||
v-if="!givenName"
|
||||
class="bg-amber-200 text-amber-900 border-amber-500 border-dashed border text-center rounded-md overflow-hidden px-4 py-3 mt-4"
|
||||
>
|
||||
<p class="mb-2">
|
||||
<b>Note:</b> your identity currently does <b>not</b> include a name.
|
||||
</p>
|
||||
<button
|
||||
class="text-center text-slate-600 leading-none bg-white p-2 rounded-full drop-shadow-lg"
|
||||
@click="handleBack"
|
||||
class="inline-block text-md uppercase bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-4 py-2 rounded-md"
|
||||
@click="openUserNameDialog"
|
||||
>
|
||||
<font-awesome icon="xmark" class="size-6"></font-awesome>
|
||||
Set Your Name
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<UserNameDialog ref="userNameDialog" />
|
||||
|
||||
<div
|
||||
v-if="activeDid && activeDid.startsWith(ETHR_DID_PREFIX)"
|
||||
class="block w-full max-w-[calc((100vh-env(safe-area-inset-top)-env(safe-area-inset-bottom))*0.4)] mx-auto mt-4"
|
||||
@click="onCopyUrlToClipboard()"
|
||||
>
|
||||
<!--
|
||||
Play with display options: https://qr-code-styling.com/
|
||||
See docs: https://www.npmjs.com/package/qr-code-generator-vue3
|
||||
-->
|
||||
<QRCodeVue3
|
||||
:value="qrValue"
|
||||
:width="606"
|
||||
:height="606"
|
||||
:corners-square-options="{ type: 'square' }"
|
||||
:dots-options="{ type: 'square', color: '#000' }"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div v-else-if="activeDid" class="text-center mt-4">
|
||||
<!-- Not an ETHR DID so force them to paste it. (Passkey Peer DIDs are too big.) -->
|
||||
<span class="text-blue-500" @click="onCopyDidToClipboard()">
|
||||
Click here to copy your DID to your clipboard.
|
||||
</span>
|
||||
<span>
|
||||
Then give it to them so they can paste it in their list of People.
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div v-else class="text-center mt-4">
|
||||
You have no identitifiers yet, so
|
||||
<router-link
|
||||
:to="{ name: 'start' }"
|
||||
class="bg-blue-500 text-white px-1.5 py-1 rounded-md"
|
||||
>
|
||||
create your identifier.
|
||||
</router-link>
|
||||
<br />
|
||||
If you don't do that first, these contacts won't see your activity.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div
|
||||
class="relative w-full max-w-[calc((100vh-env(safe-area-inset-top)-env(safe-area-inset-bottom))*0.4)] mx-auto border border-dashed border-white mt-8 aspect-square"
|
||||
>
|
||||
<p
|
||||
class="absolute top-0 left-0 right-0 bg-black bg-opacity-50 text-white text-sm text-center py-2 z-10"
|
||||
>
|
||||
Position QR code in the frame
|
||||
</p>
|
||||
|
||||
<p
|
||||
v-if="error"
|
||||
class="absolute bottom-0 left-0 right-0 bg-black bg-opacity-50 text-sm text-center py-2 z-20 text-rose-400"
|
||||
>
|
||||
{{ error }}
|
||||
</p>
|
||||
</div>
|
||||
</section>
|
||||
</template>
|
||||
@@ -33,18 +113,29 @@ import { NotificationIface } from "../constants/app";
|
||||
import { db } from "../db/index";
|
||||
import { Contact } from "../db/tables/contacts";
|
||||
import { getContactJwtFromJwtUrl } from "../libs/crypto";
|
||||
import { decodeEndorserJwt } from "../libs/crypto/vc";
|
||||
import { decodeEndorserJwt, ETHR_DID_PREFIX } from "../libs/crypto/vc";
|
||||
import { retrieveSettingsForActiveAccount } from "../db/index";
|
||||
import { setVisibilityUtil } from "../libs/endorserServer";
|
||||
import { useClipboard } from "@vueuse/core";
|
||||
import QRCodeVue3 from "qr-code-generator-vue3";
|
||||
import UserNameDialog from "../components/UserNameDialog.vue";
|
||||
import { generateEndorserJwtUrlForAccount } from "../libs/endorserServer";
|
||||
import { retrieveAccountMetadata } from "../libs/util";
|
||||
|
||||
interface QRScanResult {
|
||||
rawValue?: string;
|
||||
barcode?: string;
|
||||
}
|
||||
|
||||
interface IUserNameDialog {
|
||||
open: (callback: (name: string) => void) => void;
|
||||
}
|
||||
|
||||
@Component({
|
||||
components: {
|
||||
QuickNav,
|
||||
QRCodeVue3,
|
||||
UserNameDialog,
|
||||
},
|
||||
})
|
||||
export default class ContactQRScan extends Vue {
|
||||
@@ -55,11 +146,14 @@ export default class ContactQRScan extends Vue {
|
||||
error: string | null = null;
|
||||
activeDid = "";
|
||||
apiServer = "";
|
||||
givenName = "";
|
||||
qrValue = "";
|
||||
ETHR_DID_PREFIX = ETHR_DID_PREFIX;
|
||||
|
||||
// Add new properties to track scanning state
|
||||
private lastScannedValue: string = "";
|
||||
private lastScanTime: number = 0;
|
||||
private readonly SCAN_DEBOUNCE_MS = 2000; // Prevent duplicate scans within 2 seconds
|
||||
private readonly SCAN_DEBOUNCE_MS = 5000; // Increased from 2000 to 5000ms to better handle mobile scanning
|
||||
|
||||
// Add cleanup tracking
|
||||
private isCleaningUp = false;
|
||||
@@ -70,6 +164,21 @@ export default class ContactQRScan extends Vue {
|
||||
const settings = await retrieveSettingsForActiveAccount();
|
||||
this.activeDid = settings.activeDid || "";
|
||||
this.apiServer = settings.apiServer || "";
|
||||
this.givenName = settings.firstName || "";
|
||||
|
||||
const account = await retrieveAccountMetadata(this.activeDid);
|
||||
if (account) {
|
||||
const name =
|
||||
(settings.firstName || "") +
|
||||
(settings.lastName ? ` ${settings.lastName}` : "");
|
||||
this.qrValue = await generateEndorserJwtUrlForAccount(
|
||||
account,
|
||||
!!settings.isRegistered,
|
||||
name,
|
||||
settings.profileImageUrl || "",
|
||||
false,
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error("Error initializing component:", {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
@@ -270,14 +379,12 @@ export default class ContactQRScan extends Vue {
|
||||
notes: contactInfo.notes || "",
|
||||
};
|
||||
|
||||
// Add contact and stop scanning
|
||||
// Add contact but keep scanning
|
||||
logger.info("Adding new contact to database:", {
|
||||
did: contact.did,
|
||||
name: contact.name,
|
||||
});
|
||||
await this.addNewContact(contact);
|
||||
await this.stopScanning();
|
||||
this.$router.back(); // Return to previous view after successful scan
|
||||
} catch (error) {
|
||||
logger.error("Error processing contact QR code:", {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
@@ -420,6 +527,56 @@ export default class ContactQRScan extends Vue {
|
||||
await this.cleanupScanner();
|
||||
this.$router.back();
|
||||
}
|
||||
|
||||
toastQRCodeHelp() {
|
||||
this.$notify(
|
||||
{
|
||||
group: "alert",
|
||||
type: "info",
|
||||
title: "QR Code Help",
|
||||
text: "Click the QR code to copy your contact info to your clipboard.",
|
||||
},
|
||||
5000,
|
||||
);
|
||||
}
|
||||
|
||||
onCopyUrlToClipboard() {
|
||||
useClipboard()
|
||||
.copy(this.qrValue)
|
||||
.then(() => {
|
||||
this.$notify(
|
||||
{
|
||||
group: "alert",
|
||||
type: "toast",
|
||||
title: "Copied",
|
||||
text: "Contact URL was copied to clipboard.",
|
||||
},
|
||||
2000,
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
onCopyDidToClipboard() {
|
||||
useClipboard()
|
||||
.copy(this.activeDid)
|
||||
.then(() => {
|
||||
this.$notify(
|
||||
{
|
||||
group: "alert",
|
||||
type: "info",
|
||||
title: "Copied",
|
||||
text: "Your DID was copied to the clipboard. Have them paste it in the box on their 'People' screen to add you.",
|
||||
},
|
||||
5000,
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
openUserNameDialog() {
|
||||
(this.$refs.userNameDialog as IUserNameDialog).open((name: string) => {
|
||||
this.givenName = name;
|
||||
});
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
@@ -42,7 +42,7 @@
|
||||
|
||||
<div
|
||||
v-if="activeDid && activeDid.startsWith(ETHR_DID_PREFIX)"
|
||||
class="block w-[90vw] max-w-[40vh] mx-auto my-4"
|
||||
class="block w-[90vw] max-w-[calc((100vh-env(safe-area-inset-top)-env(safe-area-inset-bottom))*0.4)] mx-auto my-4"
|
||||
@click="onCopyUrlToClipboard()"
|
||||
>
|
||||
<!--
|
||||
@@ -75,13 +75,13 @@
|
||||
create your identifier.
|
||||
</router-link>
|
||||
<br />
|
||||
If you don't that first, these contacts won't see your activity.
|
||||
If you don't do that first, these contacts won't see your activity.
|
||||
</div>
|
||||
|
||||
<div class="text-center mt-6">
|
||||
<div
|
||||
v-if="isScanning && !isNativePlatform"
|
||||
class="relative aspect-square overflow-hidden bg-slate-800 w-[90vw] max-w-[40vh] mx-auto"
|
||||
v-if="isScanning"
|
||||
class="relative aspect-square overflow-hidden bg-slate-800 w-[90vw] max-w-[calc((100vh-env(safe-area-inset-top)-env(safe-area-inset-bottom))*0.4)] mx-auto"
|
||||
>
|
||||
<!-- Status Message -->
|
||||
<div
|
||||
@@ -142,8 +142,9 @@
|
||||
</div>
|
||||
|
||||
<qrcode-stream
|
||||
v-if="useQRReader && !isNativePlatform"
|
||||
v-if="useQRReader"
|
||||
:camera="preferredCamera"
|
||||
class="qr-scanner"
|
||||
@decode="onDecode"
|
||||
@init="onInit"
|
||||
@detect="onDetect"
|
||||
@@ -167,17 +168,9 @@
|
||||
</div>
|
||||
<div
|
||||
v-else
|
||||
class="flex items-center justify-center aspect-square overflow-hidden bg-slate-800 w-[90vw] max-w-[40vh] mx-auto"
|
||||
class="flex items-center justify-center aspect-square overflow-hidden bg-slate-800 w-[90vw] max-w-[calc((100vh-env(safe-area-inset-top)-env(safe-area-inset-bottom))*0.4)] mx-auto"
|
||||
>
|
||||
<button
|
||||
v-if="isNativePlatform"
|
||||
class="bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white text-lg px-3 py-2 rounded-lg"
|
||||
@click="$router.push({ name: 'contact-qr-scan' })"
|
||||
>
|
||||
Scan QR Code
|
||||
</button>
|
||||
<button
|
||||
v-else
|
||||
class="bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white text-lg px-3 py-2 rounded-lg"
|
||||
@click="startScanning"
|
||||
>
|
||||
@@ -193,7 +186,6 @@ import { AxiosError } from "axios";
|
||||
import QRCodeVue3 from "qr-code-generator-vue3";
|
||||
import { Component, Vue } from "vue-facing-decorator";
|
||||
import { useClipboard } from "@vueuse/core";
|
||||
import { Capacitor } from "@capacitor/core";
|
||||
import { QrcodeStream } from "vue-qrcode-reader";
|
||||
|
||||
import QuickNav from "../components/QuickNav.vue";
|
||||
@@ -244,7 +236,6 @@ export default class ContactQRScanShow extends Vue {
|
||||
qrValue = "";
|
||||
isScanning = false;
|
||||
error: string | null = null;
|
||||
isNativePlatform = Capacitor.isNativePlatform();
|
||||
|
||||
// QR Scanner properties
|
||||
isInitializing = true;
|
||||
@@ -265,6 +256,9 @@ export default class ContactQRScanShow extends Vue {
|
||||
private isCleaningUp = false;
|
||||
private isMounted = false;
|
||||
|
||||
// Add property to track if we're on desktop
|
||||
private isDesktop = false;
|
||||
|
||||
async created() {
|
||||
try {
|
||||
const settings = await retrieveSettingsForActiveAccount();
|
||||
@@ -534,13 +528,12 @@ export default class ContactQRScanShow extends Vue {
|
||||
notes: contactInfo.notes || "",
|
||||
};
|
||||
|
||||
// Add contact and stop scanning
|
||||
// Add contact but keep scanning
|
||||
logger.info("Adding new contact to database:", {
|
||||
did: contact.did,
|
||||
name: contact.name,
|
||||
});
|
||||
await this.addNewContact(contact);
|
||||
await this.stopScanning();
|
||||
} catch (error) {
|
||||
logger.error("Error processing contact QR code:", {
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
@@ -692,6 +685,7 @@ export default class ContactQRScanShow extends Vue {
|
||||
{
|
||||
group: "alert",
|
||||
type: "info",
|
||||
title: "QR Code Help",
|
||||
text: "Click the QR code to copy your contact info to your clipboard.",
|
||||
},
|
||||
5000,
|
||||
@@ -724,12 +718,19 @@ export default class ContactQRScanShow extends Vue {
|
||||
// Lifecycle hooks
|
||||
mounted() {
|
||||
this.isMounted = true;
|
||||
this.isDesktop = this.detectDesktopBrowser();
|
||||
document.addEventListener("pause", this.handleAppPause);
|
||||
document.addEventListener("resume", this.handleAppResume);
|
||||
// Start scanning automatically when view is loaded, but only on web platform
|
||||
if (!this.isNativePlatform) {
|
||||
this.startScanning();
|
||||
}
|
||||
// Start scanning automatically when view is loaded
|
||||
this.startScanning();
|
||||
|
||||
// Apply mirroring after a short delay to ensure video element is ready
|
||||
setTimeout(() => {
|
||||
const videoElement = document.querySelector('.qr-scanner video') as HTMLVideoElement;
|
||||
if (videoElement) {
|
||||
videoElement.style.transform = 'scaleX(-1)';
|
||||
}
|
||||
}, 1000);
|
||||
}
|
||||
|
||||
beforeDestroy() {
|
||||
@@ -856,11 +857,6 @@ export default class ContactQRScanShow extends Vue {
|
||||
|
||||
async onInit(promise: Promise<void>): Promise<void> {
|
||||
logger.log("[QRScanner] onInit called");
|
||||
if (this.isNativePlatform) {
|
||||
logger.log("Skipping QR scanner initialization on native platform");
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
await promise;
|
||||
this.isInitializing = false;
|
||||
@@ -889,7 +885,7 @@ export default class ContactQRScanShow extends Vue {
|
||||
|
||||
onDetect(result: unknown): void {
|
||||
this.isScanning = true;
|
||||
this.cameraState = "detecting";
|
||||
this.cameraState = "active";
|
||||
try {
|
||||
let rawValue: string | undefined;
|
||||
if (
|
||||
@@ -899,7 +895,7 @@ export default class ContactQRScanShow extends Vue {
|
||||
) {
|
||||
rawValue = result[0].rawValue;
|
||||
} else if (result && typeof result === "object" && "rawValue" in result) {
|
||||
rawValue = result.rawValue;
|
||||
rawValue = (result as { rawValue: string }).rawValue;
|
||||
}
|
||||
if (rawValue) {
|
||||
this.isInitializing = false;
|
||||
@@ -909,7 +905,6 @@ export default class ContactQRScanShow extends Vue {
|
||||
} catch (error) {
|
||||
this.handleError(error);
|
||||
} finally {
|
||||
this.isScanning = false;
|
||||
this.cameraState = "active";
|
||||
}
|
||||
}
|
||||
@@ -944,6 +939,22 @@ export default class ContactQRScanShow extends Vue {
|
||||
stack: error.stack,
|
||||
});
|
||||
}
|
||||
|
||||
// Add method to detect desktop browser
|
||||
private detectDesktopBrowser(): boolean {
|
||||
const userAgent = navigator.userAgent.toLowerCase();
|
||||
return !/android|webos|iphone|ipad|ipod|blackberry|iemobile|opera mini/i.test(userAgent);
|
||||
}
|
||||
|
||||
// Update the computed property for camera mirroring
|
||||
get shouldMirrorCamera(): boolean {
|
||||
// On desktop, always mirror the webcam
|
||||
if (this.isDesktop) {
|
||||
return true;
|
||||
}
|
||||
// On mobile, mirror only for front-facing camera
|
||||
return this.preferredCamera === "user";
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
@@ -951,4 +962,18 @@ export default class ContactQRScanShow extends Vue {
|
||||
.aspect-square {
|
||||
aspect-ratio: 1 / 1;
|
||||
}
|
||||
|
||||
/* Update styles for camera mirroring */
|
||||
:deep(.qr-scanner) {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
:deep(.qr-scanner video) {
|
||||
transform: scaleX(-1);
|
||||
}
|
||||
|
||||
/* Ensure the canvas for QR detection is not mirrored */
|
||||
:deep(.qr-scanner canvas) {
|
||||
transform: none;
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -1,92 +0,0 @@
|
||||
<template>
|
||||
<section id="Content" class="p-6 pb-24 max-w-3xl mx-auto">
|
||||
<!-- Breadcrumb -->
|
||||
<div id="ViewBreadcrumb" class="mb-8">
|
||||
<h1 class="text-lg text-center font-light relative px-7">
|
||||
<!-- Cancel -->
|
||||
<router-link
|
||||
:to="{ name: 'account' }"
|
||||
class="text-lg text-center px-2 py-1 absolute -left-2 -top-1"
|
||||
><font-awesome icon="chevron-left" class="fa-fw"></font-awesome>
|
||||
</router-link>
|
||||
|
||||
Scan Contact
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
<h3 class="text-sm uppercase font-semibold mb-2">Scan a QR Code…</h3>
|
||||
<div class="bg-black rounded overflow-hidden relative mb-4">
|
||||
<img src="https://picsum.photos/400/400?random=1" class="w-full" />
|
||||
|
||||
<!-- Darken overlay -->
|
||||
<!-- Top -->
|
||||
<div class="absolute top-0 left-0 right-0 bg-black/50 h-1/4"></div>
|
||||
<!-- Reft -->
|
||||
<div class="absolute top-1/4 bottom-1/4 left-0 bg-black/50 w-1/4"></div>
|
||||
<!-- Right -->
|
||||
<div class="absolute top-1/4 bottom-1/4 right-0 bg-black/50 w-1/4"></div>
|
||||
<!-- Bottom -->
|
||||
<div class="absolute bottom-0 left-0 right-0 bg-black/50 h-1/4"></div>
|
||||
|
||||
<!-- Reticle overlay -->
|
||||
<!-- Top-left -->
|
||||
<div
|
||||
class="absolute top-1/4 left-1/4 h-6 w-6 border-white border-t-4 border-l-4 drop-shadow"
|
||||
></div>
|
||||
<!-- Top-right -->
|
||||
<div
|
||||
class="absolute top-1/4 right-1/4 h-6 w-6 border-white border-t-4 border-r-4 drop-shadow"
|
||||
></div>
|
||||
<!-- Bottom-left -->
|
||||
<div
|
||||
class="absolute bottom-1/4 left-1/4 h-6 w-6 border-white border-b-4 border-l-4 drop-shadow"
|
||||
></div>
|
||||
<!-- Bottom-right -->
|
||||
<div
|
||||
class="absolute bottom-1/4 right-1/4 h-6 w-6 border-white border-b-4 border-r-4 drop-shadow"
|
||||
></div>
|
||||
</div>
|
||||
|
||||
<h3 class="text-sm uppercase font-semibold mb-2">…or Enter Contact Data</h3>
|
||||
<input
|
||||
type="text"
|
||||
placeholder="Name (optional)"
|
||||
class="block w-full rounded border border-slate-400 mb-2 px-3 py-2"
|
||||
/>
|
||||
<input
|
||||
type="text"
|
||||
placeholder="ID"
|
||||
class="block w-full rounded border border-slate-400 mb-2 px-3 py-2"
|
||||
/>
|
||||
<input
|
||||
type="text"
|
||||
placeholder="Public Key (optional)"
|
||||
class="block w-full rounded border border-slate-400 mb-4 px-3 py-2"
|
||||
/>
|
||||
|
||||
<div class="mt-8">
|
||||
<div class="grid grid-cols-1 sm:grid-cols-2 gap-2">
|
||||
<input
|
||||
type="submit"
|
||||
class="block w-full text-center text-lg font-bold uppercase bg-gradient-to-b from-blue-400 to-blue-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-2 py-3 rounded-md"
|
||||
value="Look Up Contact"
|
||||
/>
|
||||
<button
|
||||
type="button"
|
||||
class="block w-full text-center text-md uppercase bg-gradient-to-b from-slate-400 to-slate-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-1.5 py-2 rounded-md"
|
||||
>
|
||||
Cancel
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import { Component, Vue } from "vue-facing-decorator";
|
||||
|
||||
@Component({
|
||||
components: {},
|
||||
})
|
||||
export default class ContactScanView extends Vue {}
|
||||
</script>
|
||||
@@ -69,12 +69,12 @@
|
||||
</span>
|
||||
</span>
|
||||
|
||||
<router-link
|
||||
:to="{ name: 'contact-qr' }"
|
||||
<button
|
||||
class="flex items-center bg-gradient-to-b from-green-400 to-green-700 shadow-[inset_0_-1px_0_0_rgba(0,0,0,0.5)] text-white px-1.5 py-1 mr-1 rounded-md"
|
||||
@click="handleQRCodeClick"
|
||||
>
|
||||
<font-awesome icon="qrcode" class="fa-fw text-2xl" />
|
||||
</router-link>
|
||||
</button>
|
||||
|
||||
<textarea
|
||||
v-model="contactInput"
|
||||
@@ -353,6 +353,7 @@ import * as R from "ramda";
|
||||
import { Component, Vue } from "vue-facing-decorator";
|
||||
import { RouteLocationNormalizedLoaded, Router } from "vue-router";
|
||||
import { useClipboard } from "@vueuse/core";
|
||||
import { Capacitor } from "@capacitor/core";
|
||||
|
||||
import QuickNav from "../components/QuickNav.vue";
|
||||
import EntityIcon from "../components/EntityIcon.vue";
|
||||
@@ -1438,5 +1439,13 @@ export default class ContactsView extends Vue {
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private handleQRCodeClick() {
|
||||
if (Capacitor.isNativePlatform()) {
|
||||
this.$router.push({ name: "contact-qr-scan-full" });
|
||||
} else {
|
||||
this.$router.push({ name: "contact-qr" });
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
@@ -549,8 +549,8 @@
|
||||
<h2 class="text-xl font-semibold">Where can I read more?</h2>
|
||||
<p>
|
||||
This is part of the
|
||||
<a href="https://livesofgiving.org" target="_blank" class="text-blue-500">
|
||||
Lives of Giving
|
||||
<a href="https://livesofimpact.org" target="_blank" class="text-blue-500">
|
||||
Lives of Impact
|
||||
</a>
|
||||
initiative.
|
||||
</p>
|
||||
|
||||
@@ -740,7 +740,7 @@ export default class HomeView extends Vue {
|
||||
* - Displays user notification
|
||||
*
|
||||
* @internal
|
||||
* Called by mounted() and handleFeedError()
|
||||
* Called by mounted()
|
||||
* @param err Error object with optional userMessage
|
||||
*/
|
||||
private handleError(err: unknown) {
|
||||
|
||||
@@ -32,6 +32,13 @@
|
||||
size="128"
|
||||
></font-awesome>
|
||||
</div>
|
||||
<div v-else-if="hitError">
|
||||
<span class="text-xl">Error Creating Identity</span>
|
||||
<font-awesome icon="exclamation-triangle" class="fa-fw text-red-500 ml-2"></font-awesome>
|
||||
<p class="text-sm text-gray-500">
|
||||
Try fully restarting the app. If that doesn't work, back up all data (identities and other data) and reinstall the app.
|
||||
</p>
|
||||
</div>
|
||||
<div v-else>
|
||||
<span class="text-xl">Created!</span>
|
||||
<font-awesome
|
||||
@@ -62,14 +69,24 @@ import QuickNav from "../components/QuickNav.vue";
|
||||
@Component({ components: { QuickNav } })
|
||||
export default class NewIdentifierView extends Vue {
|
||||
loading = true;
|
||||
hitError = false;
|
||||
$router!: Router;
|
||||
|
||||
async mounted() {
|
||||
await generateSaveAndActivateIdentity();
|
||||
this.loading = false;
|
||||
setTimeout(() => {
|
||||
this.$router.push({ name: "home" });
|
||||
}, 1000);
|
||||
this.loading = true;
|
||||
this.hitError = false;
|
||||
generateSaveAndActivateIdentity()
|
||||
.then(() => {
|
||||
this.loading = false;
|
||||
setTimeout(() => {
|
||||
this.$router.push({ name: "home" });
|
||||
}, 1000);
|
||||
})
|
||||
.catch((error) => {
|
||||
this.loading = false;
|
||||
this.hitError = true;
|
||||
console.error('Failed to generate identity:', error);
|
||||
});
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
Reference in New Issue
Block a user