mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-13 07:40:59 +00:00
Maurice
825469a7f2
TREK now appears under "Open in" and in the share sheet for PDFs, calendar entries, Wallet passes and mails (iOS document types, Android VIEW and SEND filters). The native side reads the file (up to 15 MB) and hands it to the UI, which asks which trip it belongs to, upcoming trips first, then opens that trip's booking import with the file already chosen.
94 lines
4.0 KiB
TypeScript
94 lines
4.0 KiB
TypeScript
import { registerPlugin } from '@capacitor/core';
|
|
import type { NativeCapabilities } from './capabilities';
|
|
|
|
/**
|
|
* The app's own native plugin, implemented in
|
|
* ios/App/App/TrekShellPlugin.swift and
|
|
* android/app/src/main/java/com/liketrek/trek/TrekShellPlugin.java.
|
|
*
|
|
* The app is a frame around the UI the user's server delivers, so what the
|
|
* web side needs from it is small: which server that is, a way to change it,
|
|
* a system browser for the sign-ins a WebView cannot do, and on iOS the
|
|
* offline copy of the start page that stands in for the missing service
|
|
* worker.
|
|
*/
|
|
export interface TrekShellPlugin {
|
|
getServer(): Promise<{ url: string | null }>;
|
|
/** Remembers the server and loads it. The current page is gone afterwards. */
|
|
setServer(options: { url: string }): Promise<void>;
|
|
/** Forgets the server and returns to the address screen. */
|
|
resetServer(): Promise<void>;
|
|
/** Loads the remembered server again, after it could not be reached. */
|
|
reload(): Promise<void>;
|
|
/**
|
|
* Opens `url` in the system browser and resolves with the URL it was sent
|
|
* back to under `callbackScheme`. Rejects with code `CANCELLED` when the
|
|
* user closes the browser.
|
|
*/
|
|
authenticate(options: { url: string; callbackScheme: string }): Promise<{ url: string }>;
|
|
/** iOS: stores the server's start page for a cold start without network. */
|
|
refreshOfflineCopy(): Promise<{ saved: boolean }>;
|
|
/** iOS: loads that copy under the server's origin. False when there is none. */
|
|
openOfflineCopy(): Promise<{ opened: boolean }>;
|
|
/** What this binary offers the UI (native/capabilities.ts). Missing before shell API 2. */
|
|
getCapabilities(): Promise<NativeCapabilities>;
|
|
/** iOS, feature tileCache: what the map tile store takes on disk, and its limit. */
|
|
getTileCacheUsage(): Promise<{ bytes: number; limit: number }>;
|
|
/** iOS, feature tileCache: empties the map tile store. */
|
|
clearTileCache(): Promise<void>;
|
|
/** Feature biometricLock: which biometry the device offers for the app lock. */
|
|
biometryInfo(): Promise<{ available: boolean; type: string }>;
|
|
/** Feature biometricLock: Face ID, Touch ID or the passcode. Rejects with CANCELLED or FAILED. */
|
|
authenticateBiometric(options: { reason: string }): Promise<{ ok: true }>;
|
|
/** Feature biometricLock: a blurred cover in the app switcher while the lock is on. */
|
|
setPrivacyCover(options: { enabled: boolean }): Promise<void>;
|
|
/** iOS, feature geolocation: starts the native location stream (the "location" event). */
|
|
startLocation(options: { highAccuracy: boolean }): Promise<void>;
|
|
stopLocation(): Promise<void>;
|
|
addListener(
|
|
event: 'location',
|
|
listener: (payload: NativeLocationPayload) => void
|
|
): Promise<{ remove: () => Promise<void> }>;
|
|
addListener(
|
|
event: 'sharedFile',
|
|
listener: (payload: SharedFilePayload) => void
|
|
): Promise<{ remove: () => Promise<void> }>;
|
|
/** Feature sharedFiles: the booking document shared to TREK before the UI ran. */
|
|
takeSharedFile(): Promise<{ file: SharedFilePayload | null }>;
|
|
}
|
|
|
|
/** A document shared to TREK, as the native side reads it. */
|
|
export interface SharedFilePayload {
|
|
name: string;
|
|
mimeType: string;
|
|
/** base64 */
|
|
data: string;
|
|
}
|
|
|
|
/** A position, or an error shaped like GeolocationPositionError (1 denied, 2 unavailable). */
|
|
export type NativeLocationPayload =
|
|
| {
|
|
latitude: number;
|
|
longitude: number;
|
|
accuracy: number;
|
|
altitude: number | null;
|
|
speed: number | null;
|
|
heading: number | null;
|
|
timestamp: number;
|
|
error?: undefined;
|
|
}
|
|
| { error: { code: number; message: string } };
|
|
|
|
export const TrekShell = registerPlugin<TrekShellPlugin>('TrekShell');
|
|
|
|
export const APP_URL_SCHEME = 'com.liketrek.trek';
|
|
|
|
/**
|
|
* True for the rejection Capacitor gives when the installed app has no such
|
|
* native method: the UI comes from the server, so a newer server can call into
|
|
* an app binary that predates the method.
|
|
*/
|
|
export function isUnimplemented(err: unknown): boolean {
|
|
return typeof err === 'object' && err !== null && (err as { code?: unknown }).code === 'UNIMPLEMENTED';
|
|
}
|