@octane-xplat/platform 0.1.0 → 0.4.0

package/src/types.ts

@@ -4,68 +4,137 @@
 
 /** Optional capability — never throws for absence (docs/platform-services.md). */
 export interface Capability<T> {
-	supported: boolean;
-	ensure(): Promise<'granted' | 'denied' | 'unsupported'>;
+	supported: boolean
+	ensure(): Promise<'granted' | 'denied' | 'unsupported'>
 	/** usable iff supported && ensured */
-	impl: T | null;
+	impl: T | null
 }
 
-export type AppState = 'active' | 'background' | 'inactive';
+export type AppState = 'active' | 'background' | 'inactive'
 
 export interface DeviceInfo {
-	os: 'web' | 'ios' | 'android';
-	osVersion: string;
-	model: string;
-	manufacturer: string;
-	language: string;
-	region: string;
+	os: 'web' | 'ios' | 'android'
+	osVersion: string
+	model: string
+	manufacturer: string
+	language: string
+	region: string
 }
 
 export interface Insets {
-	top: number;
-	bottom: number;
-	left: number;
-	right: number;
+	top: number
+	bottom: number
+	left: number
+	right: number
 }
 
 export interface WindowSize {
-	width: number;
-	height: number;
-	orientation: 'portrait' | 'landscape';
+	width: number
+	height: number
+	orientation: 'portrait' | 'landscape'
 }
 
 export interface FileRef {
-	name: string;
+	name: string
 	/** blob:/object URL on web, filesystem path on native — opaque */
-	uri: string;
+	uri: string
+}
+
+/**
+ * Result of `media.pickImage()`: a displayable URI and an upload data URL.
+ * Native URIs point to temporary JPEG files; call `files.release()` when the
+ * preview is no longer needed.
+ */
+export interface PickedImage extends FileRef {
+	dataUrl: string
 }
 
 export interface Locale {
-	tag: string;
-	language: string;
-	region: string;
+	tag: string
+	language: string
+	region: string
 }
 
 export interface SecureStore {
-	get(key: string): Promise<string | null>;
-	set(key: string, value: string): Promise<boolean>;
-	remove(key: string): Promise<boolean>;
+	get(key: string): Promise<string | null>
+	set(key: string, value: string): Promise<boolean>
+	remove(key: string): Promise<boolean>
 }
 
 export interface HapticsImpl {
-	impact(style?: 'light' | 'medium' | 'heavy'): void;
-	notification(kind: 'success' | 'warning' | 'error'): void;
-	selection(): void;
+	impact(style?: 'light' | 'medium' | 'heavy'): void
+	notification(kind: 'success' | 'warning' | 'error'): void
+	selection(): void
 }
 
 export interface NotificationsImpl {
-	notify(title: string, body?: string): void;
+	notify(title: string, body?: string): void
 }
 
 export interface BiometricsImpl {
-	verify(reason: string): Promise<boolean>;
+	verify(reason: string): Promise<boolean>
+}
+
+export type PermissionResult = 'granted' | 'denied' | 'unsupported'
+
+export type PermissionKind = 'notifications' | 'camera' | 'photos' | 'location'
+
+export type MediaPermissionKind = 'camera' | 'photos'
+
+export interface GeolocationOptions {
+	enableHighAccuracy?: boolean
+	timeout?: number
+	maximumAge?: number
+}
+
+export interface GeolocationPosition {
+	latitude: number
+	longitude: number
+	accuracy: number
+	altitude: number | null
+	heading: number | null
+	speed: number | null
+	timestamp: number
+}
+
+export interface GeolocationImpl {
+	getCurrentPosition(options?: GeolocationOptions): Promise<GeolocationPosition>
 }
 
-export type PermissionKind = 'notifications' | 'camera' | 'photos' | 'location';
+export type ConnectionType =
+	| 'none'
+	| 'wifi'
+	| 'mobile'
+	| 'ethernet'
+	| 'bluetooth'
+	| 'vpn'
+	| 'unknown'
+
+export interface ConnectivityState {
+	online: boolean
+	type: ConnectionType
+}
+
+export interface ConnectivityImpl {
+	getState(): ConnectivityState
+	subscribe(listener: (state: ConnectivityState) => void): () => void
+}
+
+export interface AppInfo {
+	supported: boolean
+	version: string | null
+	build: string | null
+	bundleId: string | null
+}
+
+export interface OpenSettingsImpl {
+	open(): boolean
+}
+
+export interface MediaImpl {
+	pickImage(): Promise<PickedImage | null>
+	pickImages(): Promise<PickedImage[]>
+	ensure(kind: MediaPermissionKind): Promise<PermissionResult>
+}
 
-export type ShareResult = 'shared' | 'copied' | 'unavailable';
+export type ShareResult = 'shared' | 'copied' | 'unavailable'