@aegis-framework/artemis/dist/types/SpaceAdapter/types.d.ts

Aegis Framework Javascript Library

/**
 * ==============================
 * Space Adapter Types
 * ==============================
 */
/**
 * Base configuration for all space adapters
 */
export interface SpaceConfiguration {
    name?: string;
    version?: string;
    store?: string;
}
/**
 * LocalStorage/SessionStorage configuration
 */
export type LocalStorageConfiguration = SpaceConfiguration;
/**
 * IndexedDB configuration with additional options
 */
export interface IndexedDBConfiguration extends SpaceConfiguration {
    props?: IDBObjectStoreParameters;
    index?: Record<string, {
        name: string;
        field: string;
        props?: IDBIndexParameters;
    }>;
}
/**
 * RemoteStorage configuration
 */
export interface RemoteStorageConfiguration extends SpaceConfiguration {
    endpoint?: string;
    props?: Record<string, unknown>;
}
/**
 * Generic storage value type
 */
export type StorageValue = unknown;
/**
 * Key-value result type
 */
export interface KeyValueResult {
    key: string;
    value: StorageValue;
}
/**
 * Upgrade callback function type
 */
export type UpgradeCallback<T = unknown> = (adapter: T, event?: IDBVersionChangeEvent) => void | Promise<void>;
/**
 * Base interface for all space adapters
 */
export interface SpaceAdapterInterface {
    name: string;
    version: string;
    store: string;
    open(): Promise<this>;
    set(key: string | null, value: StorageValue): Promise<KeyValueResult>;
    update(key: string, value: StorageValue): Promise<KeyValueResult>;
    get(key: string): Promise<StorageValue>;
    getAll(): Promise<Record<string, StorageValue>>;
    contains(key: string): Promise<void>;
    upgrade(oldVersion: string, newVersion: string, callback: UpgradeCallback): Promise<void>;
    rename(name: string): Promise<void>;
    key(index: number, full?: boolean): Promise<string>;
    keys(full?: boolean): Promise<string[]>;
    remove(key: string): Promise<StorageValue>;
    clear(): Promise<void>;
    configuration?(config: SpaceConfiguration): void;
}
/**
 * Space adapter constructor type
 */
export type SpaceAdapterConstructor = new (config: SpaceConfiguration) => SpaceAdapterInterface;
/**
 * Convert a version string to a numeric value for comparison.
 * Each segment is padded to 5 digits to support versions up to 99999.x.x
 *
 * @param version - Version string (e.g., "1.0.0", "10.2.15")
 * @returns Numeric version for comparison
 */
export declare function versionToNumber(version: string): number;
/**
 * Compare two version strings
 *
 * @param v1 - First version string
 * @param v2 - Second version string
 * @returns -1 if v1 < v2, 0 if v1 === v2, 1 if v1 > v2
 */
export declare function compareVersions(v1: string, v2: string): number;
/**
 * Clone a value to isolate it from later mutation by the caller.
 *
 * Best-effort: `structuredClone` is preferred when available, with manual
 * fallbacks for Date / RegExp / Map / Set / arrays / plain objects.
 * Custom class instances (anything whose prototype is not `Object.prototype`
 * or `null`) are returned **by reference** — preserving methods/identity
 * matters more than isolating mutation, and there is no general way to
 * reconstruct an arbitrary class instance.
 *
 * @param value - Value to clone
 * @returns Cloned value, or the same reference for class instances
 */
export declare function cloneValue<T>(value: T): T;
/**
 * Normalize a URL by ensuring proper slash handling
 *
 * @param base - Base URL
 * @param path - Path to append
 * @returns Normalized URL
 */
export declare function normalizeUrl(base: string, path: string): string;
//# sourceMappingURL=types.d.ts.map