readest / apps /readest-app /src /services /sync /KOSyncClient.ts
dlxj
init
4e1096a
import { md5 } from 'js-md5';
import { Book } from '@/types/book';
import { KOSyncSettings } from '@/types/settings';
import { fetch as tauriFetch } from '@tauri-apps/plugin-http';
import { KoSyncProxyPayload } from '@/types/kosync';
import { isLanAddress } from '@/utils/network';
import { getAPIBaseUrl, isTauriAppPlatform } from '../environment';
/**
* Interface for KOSync progress response from the server
*/
export interface KoSyncProgress {
document?: string;
progress?: string;
percentage?: number;
timestamp?: number;
device?: string;
device_id?: string;
}
export class KOSyncClient {
private config: KOSyncSettings;
private isLanServer: boolean;
constructor(config: KOSyncSettings) {
this.config = config;
this.config.serverUrl = config.serverUrl.replace(/\/$/, '');
this.isLanServer = isLanAddress(this.config.serverUrl);
}
private async request(
endpoint: string,
options: {
method?: 'GET' | 'POST' | 'PUT';
body?: BodyInit | null;
headers?: HeadersInit;
useAuth?: boolean;
} = {},
): Promise<Response> {
const { method = 'GET', body, headers: additionalHeaders, useAuth = true } = options;
const headers = new Headers(additionalHeaders || {});
if (useAuth) {
headers.set('X-Auth-User', this.config.username);
headers.set('X-Auth-Key', this.config.userkey);
}
if (this.isLanServer || isTauriAppPlatform()) {
const fetch = isTauriAppPlatform() ? tauriFetch : window.fetch;
const directUrl = `${this.config.serverUrl}${endpoint}`;
return fetch(directUrl, {
method,
headers: {
accept: 'application/vnd.koreader.v1+json',
...(method === 'GET' ? {} : { 'Content-Type': 'application/json' }),
...Object.fromEntries(headers.entries()),
},
body,
danger: {
acceptInvalidCerts: true,
acceptInvalidHostnames: true,
},
});
}
const proxyUrl = `${getAPIBaseUrl()}/kosync`;
const proxyBody: KoSyncProxyPayload = {
serverUrl: this.config.serverUrl,
endpoint,
method,
headers: Object.fromEntries(headers.entries()),
body: body ? JSON.parse(body as string) : undefined,
};
return fetch(proxyUrl, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify(proxyBody),
});
}
/**
* Connects to the KOSync server with authentication
* @param username - The username for authentication
* @param password - The password for authentication
* @returns Promise with success status and optional message
*/
async connect(
username: string,
password: string,
): Promise<{ success: boolean; message?: string }> {
const userkey = md5(password);
try {
const authResponse = await this.request('/users/auth', {
method: 'GET',
headers: {
'X-Auth-User': username,
'X-Auth-Key': userkey,
},
});
if (authResponse.ok) {
return { success: true, message: 'Login successful.' };
}
if (authResponse.status === 401) {
const registerResponse = await this.request('/users/create', {
method: 'POST',
useAuth: false,
body: JSON.stringify({ username, password: userkey }),
});
if (registerResponse.ok) {
return { success: true, message: 'Registration successful.' };
}
const regError = await registerResponse.json().catch(() => ({}));
if (registerResponse.status === 402) {
return { success: false, message: 'Invalid credentials.' };
}
return { success: false, message: regError.message || 'Registration failed.' };
}
const errorBody = await authResponse.json().catch(() => ({}));
return {
success: false,
message: errorBody.message || `Authorization failed with status: ${authResponse.status}`,
};
} catch (e) {
console.error('KOSync connection failed', e);
return { success: false, message: (e as Error).message || 'Connection error.' };
}
}
/**
* Retrieves the reading progress for a specific book from the server
* @param book - The book to get progress for
* @returns Promise with the progress data or null if not found
*/
async getProgress(book: Book): Promise<KoSyncProgress | null> {
if (!this.config.userkey) return null;
const documentHash = this.getDocumentDigest(book);
if (!documentHash) return null;
try {
const response = await this.request(`/syncs/progress/${documentHash}`);
if (!response.ok) {
console.error(
`KOSync: Failed to get progress for ${book.title}. Status: ${response.status}`,
);
return null;
}
const data = await response.json();
return data.document ? data : null;
} catch (e) {
console.error('KOSync getProgress failed', e);
return null;
}
}
/**
* Updates the reading progress for a specific book on the server
* @param book - The book to update progress for
* @param progress - The current reading progress position
* @param percentage - The reading completion percentage
* @returns Promise with boolean indicating success
*/
async updateProgress(book: Book, progress: string, percentage: number): Promise<boolean> {
if (!this.config.userkey) return false;
const documentHash = this.getDocumentDigest(book);
if (!documentHash) return false;
const payload = {
document: documentHash,
progress,
percentage,
device: this.config.deviceName,
device_id: this.config.deviceId,
};
try {
const response = await this.request('/syncs/progress', {
method: 'PUT',
body: JSON.stringify(payload),
});
if (!response.ok) {
console.error(
`KOSync: Failed to update progress for ${book.title}. Status: ${response.status}`,
);
return false;
}
return true;
} catch (e) {
console.error('KOSync updateProgress failed', e);
return false;
}
}
getDocumentDigest(book: Book): string {
if (this.config.checksumMethod === 'filename') {
console.warn('This is not possible anymore, using md5 instead.');
}
return book.hash;
}
}