@quan-erp/shared-frontend-core 1.0.0

package/dist/types/core/accelerometer.d.ts

@@ -0,0 +1,47 @@
+export interface IAccelerometer {
+    start(callback: (data: {
+        x: number | null;
+        y: number | null;
+        z: number | null;
+    }) => void): void;
+    stop(): void;
+}
+export declare class WebAccelerometer implements IAccelerometer {
+    private handler?;
+    start(callback: (data: {
+        x: number | null;
+        y: number | null;
+        z: number | null;
+    }) => void): void;
+    stop(): void;
+}
+export declare class CapacitorAccelerometer extends WebAccelerometer implements IAccelerometer {
+}
+export declare class ElectronAccelerometer extends WebAccelerometer implements IAccelerometer {
+}
+/**
+ * Cross-platform Accelerometer tracking utility that delegates sensor reading requests
+ * to native Capacitor modules, Electron, or Web APIs depending on the active platform.
+ */
+export declare class Accelerometer implements IAccelerometer {
+    private static _instance;
+    private impl;
+    private constructor();
+    /**
+     * Singleton instance of the Accelerometer tracker.
+     */
+    static get instance(): Accelerometer;
+    /**
+     * Starts listening to accelerometer sensor data streams.
+     * @param callback Callback function receiving acceleration data on x, y, and z axes (in m/s²).
+     */
+    start(callback: (data: {
+        x: number | null;
+        y: number | null;
+        z: number | null;
+    }) => void): void;
+    /**
+     * Stops listening to the accelerometer sensor data streams and cleans up underlying listeners.
+     */
+    stop(): void;
+}

package/dist/types/core/assets.d.ts

@@ -0,0 +1,13 @@
+import { PluginMetadata } from "@quan-erp/shared-types";
+/**
+ * Utility class for resolving static asset URLs served by plugins on the backend.
+ */
+export declare class PluginAssets {
+    /**
+     * Resolves the backend network URL for a given plugin asset.
+     * @param metadata The plugin's module metadata.
+     * @param url The relative asset path (e.g., 'images/logo.png').
+     * @returns The fully qualified absolute URL pointing to the backend static resource.
+     */
+    static network(metadata: PluginMetadata, url: string): string;
+}

package/dist/types/core/backend-api.d.ts

@@ -0,0 +1,2 @@
+export declare function setBackendAPI(url: string): void;
+export declare function getBackendAPI(): string | null;

package/dist/types/core/background-location.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/core/battery.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Common interface defining battery status and lifecycle listeners.
+ */
+export interface IBattery {
+    getLevel(): Promise<number>;
+    isCharging(): Promise<boolean>;
+    onLevelChange(callback: (level: number) => void): void;
+    onChargingChange(callback: (charging: boolean) => void): void;
+}
+/**
+ * Cross-platform Battery tracking utility that delegates status lookups and level change event
+ * subscriptions to native Capacitor plugins, Electron, or Web Battery APIs.
+ */
+export declare class Battery {
+    private static _instance;
+    private constructor();
+    private static get impl();
+    /**
+     * Get the current battery level as a number between 0 and 1.
+     * @returns {Promise<number>} A promise that resolves with the battery level.
+     */
+    static getLevel(): Promise<number>;
+    /**
+     * Check whether the device is currently charging.
+     * @returns {Promise<boolean>} A promise that resolves to true if charging, false otherwise.
+     */
+    static isCharging(): Promise<boolean>;
+    /**
+     * Subscribe to battery level changes.
+     * @param {(level: number) => void} callback - Callback invoked when the battery level changes.
+     * @returns {() => void} A function to unsubscribe from the level change event.
+     */
+    static onLevelChange(callback: (level: number) => void): void;
+    /**
+     * Subscribe to charging status changes.
+     * @param {(charging: boolean) => void} callback - Callback invoked when the charging status changes.
+     * @returns {() => void} A function to unsubscribe from the charging change event.
+     */
+    static onChargingChange(callback: (charging: boolean) => void): void;
+}

package/dist/types/core/bluetooth.d.ts

@@ -0,0 +1,77 @@
+export interface BluetoothDeviceInfo {
+    id: string;
+    name?: string;
+}
+export interface IBluetooth {
+    requestPermission(): Promise<boolean>;
+    scan(): Promise<BluetoothDeviceInfo[]>;
+    connect(deviceId: string): Promise<void>;
+    disconnect(deviceId: string): Promise<void>;
+    isConnected(deviceId: string): Promise<boolean>;
+}
+export declare class CapacitorBluetooth implements IBluetooth {
+    private devices;
+    private connectedDevices;
+    constructor();
+    requestPermission(): Promise<boolean>;
+    scan(): Promise<BluetoothDeviceInfo[]>;
+    connect(deviceId: string): Promise<void>;
+    disconnect(deviceId: string): Promise<void>;
+    isConnected(deviceId: string): Promise<boolean>;
+}
+export declare class ElectronBluetooth implements IBluetooth {
+    private connectedDevices;
+    requestPermission(): Promise<boolean>;
+    scan(): Promise<BluetoothDeviceInfo[]>;
+    connect(deviceId: string): Promise<void>;
+    disconnect(deviceId: string): Promise<void>;
+    isConnected(deviceId: string): Promise<boolean>;
+}
+export declare class WebBluetooth implements IBluetooth {
+    private devices;
+    private connectedDevices;
+    requestPermission(): Promise<boolean>;
+    scan(): Promise<BluetoothDeviceInfo[]>;
+    connect(deviceId: string): Promise<void>;
+    disconnect(deviceId: string): Promise<void>;
+    isConnected(deviceId: string): Promise<boolean>;
+}
+/**
+ * Cross-platform Bluetooth LE tracking utility that delegates permission prompts, scanning,
+ * and connection lifecycle methods to Capacitor BLE plugins, Electron, or Web Bluetooth APIs.
+ */
+export declare class Bluetooth implements IBluetooth {
+    private impl;
+    private static _instance;
+    private constructor();
+    /**
+     * Singleton instance of the Bluetooth LE utility.
+     */
+    static get instance(): Bluetooth;
+    /**
+     * Triggers the platform's native Bluetooth permission prompt or scan dialog.
+     * @returns A promise resolving to true if permission was granted.
+     */
+    requestPermission(): Promise<boolean>;
+    /**
+     * Initiates a scanner session to discover nearby Bluetooth LE peripherals.
+     * @returns A promise resolving to a list of discovered devices.
+     */
+    scan(): Promise<BluetoothDeviceInfo[]>;
+    /**
+     * Connects to a specific Bluetooth LE device.
+     * @param deviceId Unique hardware identifier of the target device.
+     */
+    connect(deviceId: string): Promise<void>;
+    /**
+     * Closes the active GATT connection with a specific device.
+     * @param deviceId Unique hardware identifier of the target device.
+     */
+    disconnect(deviceId: string): Promise<void>;
+    /**
+     * Checks if a specific device is currently connected.
+     * @param deviceId Unique hardware identifier of the target device.
+     * @returns A promise resolving to true if connected, false otherwise.
+     */
+    isConnected(deviceId: string): Promise<boolean>;
+}

package/dist/types/core/camera.d.ts

@@ -0,0 +1,83 @@
+import { CameraResultType } from "@capacitor/camera";
+export interface ICamera {
+    requestPermission(): Promise<boolean>;
+    takePicture(): Promise<string>;
+    startPreview(videoElement: HTMLVideoElement): Promise<void>;
+    stopPreview(): void;
+    pickImageFromGallery({ resultType }: {
+        resultType: CameraResultType;
+    }): Promise<string>;
+    pickVideoFromGallery(): Promise<string>;
+}
+export declare class CapacitorCamera implements ICamera {
+    private videoEl?;
+    private stream?;
+    requestPermission(): Promise<boolean>;
+    takePicture(): Promise<string>;
+    startPreview(videoElement: HTMLVideoElement): Promise<void>;
+    stopPreview(): void;
+    pickImageFromGallery({ resultType }: {
+        resultType: CameraResultType;
+    }): Promise<string>;
+    pickVideoFromGallery(): Promise<string>;
+}
+export declare class WebCamera implements ICamera {
+    private stream?;
+    private videoEl?;
+    takePicture(): Promise<string>;
+    startPreview(videoElement: HTMLVideoElement): Promise<void>;
+    stopPreview(): void;
+    requestPermission(): Promise<boolean>;
+    pickImageFromGallery({ resultType }: {
+        resultType: CameraResultType;
+    }): Promise<string>;
+    pickVideoFromGallery(): Promise<string>;
+}
+export declare class ElectronCamera extends WebCamera {
+}
+/**
+ * Cross-platform Camera tracking utility that delegates permission requests, image capturing,
+ * live video element previews, and photo/video gallery selection to Capacitor Camera,
+ * Electron, or HTML5 MediaStream APIs depending on the active platform.
+ */
+export declare class Camera implements ICamera {
+    private static _instance;
+    private impl;
+    private constructor();
+    /**
+     * Singleton instance of the Camera utility.
+     */
+    static get instance(): Camera;
+    /**
+     * Checks and requests permission to access the camera hardware.
+     * @returns A promise resolving to true if access was successfully granted.
+     */
+    requestPermission(): Promise<boolean>;
+    /**
+     * Captures a single image using the device camera.
+     * @returns A promise resolving to the picture data encoded as a Base64 string or file URL.
+     */
+    takePicture(): Promise<string>;
+    /**
+     * Binds a real-time camera stream to a given HTMLVideoElement for a custom camera preview layout.
+     * @param videoElement The HTML5 Video element to bind the streaming media tracks to.
+     */
+    startPreview(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * Disconnects and releases the active camera streams, stopping the custom preview window.
+     */
+    stopPreview(): void;
+    /**
+     * Triggers the platform's image picker to select a photo from the local photo gallery.
+     * @param options Target result layout configurations.
+     * @returns A promise resolving to the chosen image's Base64 data or URI path.
+     */
+    pickImageFromGallery(options: {
+        resultType: CameraResultType;
+    }): Promise<string>;
+    /**
+     * Triggers the platform's video picker to select a video file from the local library.
+     * @returns A promise resolving to the chosen video's file path or URL.
+     */
+    pickVideoFromGallery(): Promise<string>;
+}

package/dist/types/core/clipboard.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Common interface defining system clipboard text reading and writing APIs.
+ */
+export interface IClipboard {
+    /** Reads the current plain text contents from the system clipboard. */
+    readText(): Promise<string>;
+    /** Writes the specified plain text to the system clipboard. */
+    writeText(text: string): Promise<void>;
+    /** Requests permission to access the system clipboard if required. */
+    requestPermission(): Promise<boolean>;
+}
+export declare class CapacitorClipboard implements IClipboard {
+    readText(): Promise<string>;
+    writeText(text: string): Promise<void>;
+    requestPermission(): Promise<boolean>;
+}
+export declare class ElectronClipboard implements IClipboard {
+    private electronClipboard;
+    readText(): Promise<string>;
+    writeText(text: string): Promise<void>;
+    requestPermission(): Promise<boolean>;
+}
+export declare class WebClipboard implements IClipboard {
+    readText(): Promise<string>;
+    writeText(text: string): Promise<void>;
+    requestPermission(): Promise<boolean>;
+}
+/**
+ * Cross-platform Clipboard utility that delegates copy/paste text actions
+ * to native Capacitor plugins, Electron, or browser Clipboard APIs depending on the environment.
+ */
+export declare class Clipboard implements IClipboard {
+    private static _instance;
+    private impl;
+    private constructor();
+    /**
+     * Singleton instance of the Clipboard utility.
+     */
+    static get instance(): Clipboard;
+    private detectPlatform;
+    /**
+     * Reads plain text from the system clipboard.
+     * @returns A promise resolving to the clipboard's string value.
+     */
+    readText(): Promise<string>;
+    /**
+     * Writes the specified text to the system clipboard.
+     * @param text The plain text string to copy.
+     */
+    writeText(text: string): Promise<void>;
+    /**
+     * Requests system clipboard permission prompts on the current platform.
+     * @returns A promise resolving to true if clipboard access was successfully permitted.
+     */
+    requestPermission(): Promise<boolean>;
+}

package/dist/types/core/database.d.ts

@@ -0,0 +1,13 @@
+import { SQLiteDBConnection } from "@capacitor-community/sqlite";
+/**
+ * Mobile-specific local SQLite database helper.
+ */
+export declare class Database {
+    private static _instance;
+    private constructor();
+    /**
+     * Retrieves the singleton mobile SQLite database connection.
+     * @returns A promise resolving to the database connection instance.
+     */
+    static getInstance(): Promise<SQLiteDBConnection>;
+}

package/dist/types/core/device-class-tier.d.ts

@@ -0,0 +1,19 @@
+type DeviceTier = "low" | "mid" | "high" | "unknown";
+/**
+ * Classifies device performance capabilities into low, mid, or high tiers.
+ * Used for dynamic feature gating and layout optimization.
+ */
+export declare class DeviceClassDetector {
+    private static _instance;
+    /**
+     * Singleton instance of the DeviceClassDetector.
+     */
+    static get instance(): DeviceClassDetector;
+    /**
+     * Detects the performance tier of the current device.
+     * Leverages RAM memory parameters, CPU core counts, and network speed signals.
+     * @returns A promise resolving to "low", "mid", "high", or "unknown" tier.
+     */
+    detect(): Promise<DeviceTier>;
+}
+export {};

package/dist/types/core/device-fingerprint.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Common interface defining unique device fingerprint retrieval APIs.
+ */
+export interface IDeviceFingerprint {
+    /**
+     * Resolves the unique device fingerprint value.
+     * @returns A promise resolving to the device fingerprint string.
+     */
+    getFingerprint(): Promise<string>;
+}
+/**
+ * Cross-platform Device Fingerprint tracking utility that delegates fingerprinting queries
+ * to native physical hardware parameters on desktop (e.g. MAC address) and FingerprintJS
+ * npm package on web, PWA, or Capacitor.
+ */
+export declare class DeviceFingerprint implements IDeviceFingerprint {
+    private impl;
+    private static _instance;
+    private constructor();
+    /**
+     * Singleton instance of the DeviceFingerprint utility.
+     */
+    static get instance(): DeviceFingerprint;
+    /**
+     * Retrieves the platform-optimized unique device fingerprint identifier.
+     * @returns A promise resolving to the visitor/device fingerprint string.
+     */
+    getFingerprint(): Promise<string>;
+}

package/dist/types/core/device.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Common interface defining system device information and hardware identifier retrieval APIs.
+ */
+export interface IDevice {
+    /** Reads the physical MAC address (or derived stable identifier) of the device. */
+    getMacAddress(): Promise<string>;
+    /** Reads the native unique device identifier (UUID / advertising ID / LocalStorage key). */
+    getDeviceId(): Promise<string>;
+}
+/**
+ * Cross-platform Device utility that delegates unique hardware identity and address querying
+ * to native Capacitor modules, Electron system layers, or persistent Web local storage keys.
+ */
+export declare class Device implements IDevice {
+    private impl;
+    private static _instance;
+    private constructor();
+    /**
+     * Singleton instance of the Device utility.
+     */
+    static get instance(): Device;
+    /**
+     * Retrieves the physical network interface MAC address of the host machine (desktop)
+     * or a derived stable custom MAC identifier matching the hardware device profile.
+     * @returns A promise resolving to the MAC address string.
+     */
+    getMacAddress(): Promise<string>;
+    /**
+     * Retrieves a platform-specific persistent unique device identifier.
+     * @returns A promise resolving to the device ID string.
+     */
+    getDeviceId(): Promise<string>;
+}

package/dist/types/core/filesystem.d.ts

@@ -0,0 +1,85 @@
+import { WriteFileOptions, ReadFileOptions, ReadFileResult, GetUriOptions, GetUriResult, StatOptions, StatResult } from "@capacitor/filesystem";
+/**
+ * Common interface defining local file-system operations (reading, writing, deleting).
+ */
+export interface IFileSystem {
+    /** Requests storage/filesystem read/write permissions from the user. */
+    requestPermission(): Promise<boolean>;
+    /** Writes text data to a specific file path. */
+    write(...args: any[]): Promise<void>;
+    /** Reads text content from a specific file path. */
+    read(...args: any[]): Promise<string | any>;
+    /** Deletes the specified file from storage. */
+    delete(path: string): Promise<void>;
+    /** Checks whether a file exists at the specified path. */
+    exists(path: string): Promise<boolean>;
+}
+export declare class WebFileSystem implements IFileSystem {
+    requestPermission(): Promise<any>;
+    write(path: string, data: string): Promise<void>;
+    read(path: string): Promise<string>;
+    delete(path: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+}
+export interface ICapacitorFileSystem extends IFileSystem {
+    write(options: WriteFileOptions): Promise<void>;
+    read(options: ReadFileOptions): Promise<ReadFileResult>;
+    getUri(options: GetUriOptions): Promise<GetUriResult>;
+    stat(option: StatOptions): Promise<StatResult>;
+}
+export declare class CapacitorFileSystem implements ICapacitorFileSystem {
+    requestPermission(): Promise<boolean>;
+    write(options: WriteFileOptions): Promise<void>;
+    read(options: ReadFileOptions): Promise<ReadFileResult>;
+    delete(path: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+    getUri(options: GetUriOptions): Promise<GetUriResult>;
+    stat(option: StatOptions): Promise<import("@capacitor/filesystem").FileInfo>;
+}
+export declare class ElectronFileSystem implements IFileSystem {
+    requestPermission(): Promise<boolean>;
+    write(path: string, data: string): Promise<void>;
+    read(path: string): Promise<string>;
+    delete(path: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+}
+/**
+ * Cross-platform FileSystem utility that delegates persistent local read/write file transactions
+ * to native Capacitor plugins, Electron preload APIs, or falling back to Web localStorage.
+ */
+export declare class FileSystem implements IFileSystem {
+    private impl;
+    private static _instance;
+    /**
+     * Singleton instance of the FileSystem utility.
+     */
+    static get instance(): IFileSystem;
+    /**
+     * Requests native filesystem permissions on the current device.
+     * @returns A promise resolving to true if permissions were granted.
+     */
+    requestPermission(): Promise<boolean>;
+    /**
+     * Writes text or data to a specific file.
+     * @param path Target relative path of the file.
+     * @param data Raw content or options to write.
+     */
+    write(path: string, data: string): Promise<void>;
+    /**
+     * Reads text or data from a specific file.
+     * @param path Target relative path of the file.
+     * @returns A promise resolving to the read contents.
+     */
+    read(path: string): Promise<any>;
+    /**
+     * Deletes a file from the device storage.
+     * @param path Target relative path to delete.
+     */
+    delete(path: string): Promise<void>;
+    /**
+     * Verifies if a file exists at the specified path.
+     * @param path Target relative path to test.
+     * @returns A promise resolving to true if the file exists, false otherwise.
+     */
+    exists(path: string): Promise<boolean>;
+}

package/dist/types/core/firebase.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Interface representing incoming Firebase push notification messages and data.
+ */
+export interface IFirebaseNotification {
+}

package/dist/types/core/gyroscope.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Common interface defining gyroscope angular rotation rate tracking APIs.
+ */
+export interface IGyroscope {
+    /** Starts listening to the gyroscope sensor streams. */
+    start(callback: (data: {
+        alpha: number | null;
+        beta: number | null;
+        gamma: number | null;
+    }) => void): void;
+    /** Stops listening to the gyroscope sensor streams. */
+    stop(): void;
+}
+export declare class WebGyroscope implements IGyroscope {
+    private handler?;
+    start(callback: (data: {
+        alpha: number | null;
+        beta: number | null;
+        gamma: number | null;
+    }) => void): void;
+    stop(): void;
+}
+export declare class CapacitorGyroscope extends WebGyroscope implements IGyroscope {
+}
+export declare class ElectronGyroscope extends WebGyroscope implements IGyroscope {
+}
+/**
+ * Cross-platform Gyroscope sensor tracking utility that delegates angular velocity queries
+ * to native Capacitor plugins, Electron, or Web DeviceOrientation APIs depending on the environment.
+ */
+export declare class Gryoscope implements IGyroscope {
+    private static _instance;
+    private impl;
+    private constructor();
+    /**
+     * Singleton instance of the Gyroscope tracker.
+     */
+    static get instance(): Gryoscope;
+    /**
+     * Starts listening to gyroscope rotation rate events.
+     * @param callback Callback function receiving rotation speed on alpha, beta, and gamma axes.
+     */
+    start(callback: (data: {
+        alpha: number | null;
+        beta: number | null;
+        gamma: number | null;
+    }) => void): void;
+    /**
+     * Stops listening to gyroscope events and releases sensor listeners.
+     */
+    stop(): void;
+}

package/dist/types/core/index.d.ts

@@ -0,0 +1,32 @@
+export * from './camera.js';
+export * from './notification.js';
+export * from './platform.js';
+export * from './filesystem.js';
+export * from './database.js';
+export * from './location.js';
+export * from './notification.js';
+export * from './permissions.js';
+export * from './network.js';
+export * from './bluetooth.js';
+export * from './clipboard.js';
+export * from './battery.js';
+export * from './system.js';
+export * from './vibration.js';
+export * from './microphone.js';
+export * from './orientation.js';
+export * from './background-location.js';
+export * from './sqlite.js';
+export * from './printer.js';
+export * from './firebase.js';
+export * from './backend-api.js';
+export * from './assets.js';
+export * from './number-formatter.js';
+export * from './system-locale.js';
+export * from './device-class-tier.js';
+export * from './user-hand-behavior.js';
+export * from './gyroscope.js';
+export * from './accelerometer.js';
+export * from './motion-orientation.js';
+export * from './plugin-api.js';
+export * from './device.js';
+export * from './device-fingerprint.js';