@aegis-framework/artemis 0.3.29 → 0.4.0

package/dist/types/Platform.d.ts

@@ -0,0 +1,93 @@
+/**
+ * ==============================
+ * Platform
+ * ==============================
+ */
+/**
+ * Desktop platform types
+ */
+export type DesktopPlatform = 'Windows' | 'macOS' | 'Linux' | 'FreeBSD' | 'webOS' | 'Any';
+/**
+ * Mobile platform types
+ */
+export type MobilePlatform = 'Android' | 'iOS' | 'Opera' | 'Windows' | 'BlackBerry' | 'Any';
+/**
+ * Orientation types
+ */
+export type Orientation = 'portrait' | 'landscape';
+/**
+ * Extended Navigator interface for userAgentData
+ */
+interface NavigatorUAData {
+    platform?: string;
+    brands?: {
+        brand: string;
+        version: string;
+    }[];
+    mobile?: boolean;
+}
+declare global {
+    interface Navigator {
+        userAgentData?: NavigatorUAData;
+    }
+}
+/**
+ * General checks for what kind of platform is being used to run the app.
+ */
+export declare class Platform {
+    /**
+     * Check if the screen has a retina pixel ratio
+     * @returns Whether the screen is retina
+     */
+    static retina(): boolean;
+    /**
+     * Check if the device is on portrait orientation
+     * @returns Whether device is in portrait mode
+     */
+    static portrait(): boolean;
+    /**
+     * Check if the device is on landscape orientation
+     * @returns Whether device is in landscape mode
+     */
+    static landscape(): boolean;
+    /**
+     * Get device Orientation
+     * @returns 'portrait' or 'landscape'
+     */
+    static orientation(): Orientation;
+    /**
+     * Check if the app is running over Electron
+     * @returns Whether running in Electron
+     */
+    static electron(): boolean;
+    /**
+     * Check if the app is running over Cordova
+     * @returns Whether running in Cordova
+     */
+    static cordova(): boolean;
+    /**
+     * Get the platform string using modern userAgentData API with fallback
+     * @returns Platform string
+     */
+    private static getPlatformString;
+    /**
+     * Check if the app is running in a desktop platform
+     * @param platform - Check for a specific desktop platform
+     * @returns Whether running on specified desktop platform
+     */
+    static desktop(platform?: DesktopPlatform): boolean;
+    /**
+     * Check if the app is running in a mobile platform
+     * @param platform - Check for a specific mobile platform
+     * @returns Whether running on specified mobile platform
+     */
+    static mobile(platform?: MobilePlatform): boolean;
+    /**
+     * Check if the platform allows the use of service workers
+     *
+     * @returns Whether service workers are supported
+     */
+    static serviceWorkers(): boolean;
+}
+export {};
+//# sourceMappingURL=Platform.d.ts.map

package/dist/types/Platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Platform.d.ts","sourceRoot":"","sources":["../../src/Platform.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,KAAK,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,KAAK,GAAG,OAAO,GAAG,SAAS,GAAG,YAAY,GAAG,KAAK,CAAC;AAE5F;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;AAEnD;;GAEG;AACH,UAAU,eAAe;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,SAAS;QAClB,aAAa,CAAC,EAAE,eAAe,CAAC;KAChC;CACD;AAeD;;GAEG;AACH,qBAAa,QAAQ;IACpB;;;OAGG;IACH,MAAM,CAAC,MAAM,IAAI,OAAO;IAIxB;;;OAGG;IACH,MAAM,CAAC,QAAQ,IAAI,OAAO;IAI1B;;;OAGG;IACH,MAAM,CAAC,SAAS,IAAI,OAAO;IAI3B;;;OAGG;IACH,MAAM,CAAC,WAAW,IAAI,WAAW;IAIjC;;;OAGG;IACH,MAAM,CAAC,QAAQ,IAAI,OAAO;IAsB1B;;;OAGG;IACH,MAAM,CAAC,OAAO,IAAI,OAAO;IAIzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAehC;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,QAAQ,GAAE,eAAuB,GAAG,OAAO;IA2B1D;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAE,cAAsB,GAAG,OAAO;IA+BxD;;;;OAIG;IACH,MAAM,CAAC,cAAc,IAAI,OAAO;CAQhC"}

package/dist/types/Preload.d.ts

@@ -0,0 +1,26 @@
+/**
+ * ==============================
+ * Preload
+ * ==============================
+ */
+/**
+ * A simple class for asset preloading. This class assumes you have a service
+ * worker set up that will be caching all requests.
+ */
+export declare class Preload {
+    /**
+     * Preload an image file
+     *
+     * @param route - Route to the image
+     * @returns Resolves to the image object or gets rejected with the rejection event
+     */
+    static image(route: string): Promise<HTMLImageElement>;
+    /**
+     * Preload any kind of file
+     *
+     * @param route - Route to the file
+     * @returns Resolves or rejects depending on request success
+     */
+    static file(route: string): Promise<Blob>;
+}
+//# sourceMappingURL=Preload.d.ts.map

package/dist/types/Preload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Preload.d.ts","sourceRoot":"","sources":["../../src/Preload.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;GAGG;AACH,qBAAa,OAAO;IACnB;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgBtD;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzC"}

package/dist/types/Request.d.ts

@@ -0,0 +1,86 @@
+/**
+ * ==============================
+ * Request
+ * ==============================
+ */
+/**
+ * Type for request data object
+ */
+export type RequestData = Record<string, string | number | boolean>;
+/**
+ * Type for request options
+ */
+export interface RequestOptions extends Omit<RequestInit, 'headers'> {
+    headers?: Record<string, string>;
+}
+/**
+ * Simple Wrapper for the fetch API, providing simple functions to handle requests
+ */
+export declare class Request {
+    /**
+     * Serialize an object of data into a URI encoded format
+     *
+     * @param data - Key-value object of data to serialize
+     * @returns Serialized Data
+     */
+    static serialize(data: RequestData): string;
+    /**
+     * Make a GET request to a given URL with the provided data parameters
+     * and an optional configuration object for the request.
+     *
+     * @param url - URL to make the request to
+     * @param data - Parameters to send in the URL, represented as a JSON object
+     * @param options - Options object for configurations you want to use in the fetch request
+     * @returns Resolves to the response of the request
+     */
+    static get(url: string, data?: RequestData, options?: RequestOptions): Promise<Response>;
+    /**
+     * Make a POST request to a given URL with the provided data and an optional
+     * configuration object for the request.
+     *
+     * @param url - URL to make the request
+     * @param data - Set of data to send in the URL, represented as a JSON object
+     * @param options - Options object for configurations you want to use in the fetch request
+     * @returns Resolves to the response of the request
+     */
+    static post(url: string, data: RequestData, options?: RequestOptions): Promise<Response>;
+    /**
+     * Make a PUT request to a given URL with the provided data and an optional
+     * configuration object for the request.
+     *
+     * @param url - URL to make the request
+     * @param data - Set of data to send in the URL, represented as a JSON object
+     * @param options - Options object for configurations you want to use in the fetch request
+     * @returns Resolves to the response of the request
+     */
+    static put(url: string, data: RequestData, options?: RequestOptions): Promise<Response>;
+    /**
+     * Make a DELETE request to a given URL with the provided data and an optional
+     * configuration object for the request.
+     *
+     * @param url - URL to make the request
+     * @param data - Parameters to send in the URL, represented as a JSON object
+     * @param options - Options object for configurations you want to use in the fetch request
+     * @returns Resolves to the response of the request
+     */
+    static delete(url: string, data: RequestData, options?: RequestOptions): Promise<Response>;
+    /**
+     * Request a JSON object from a given URL through a GET request
+     *
+     * @param url - URL to make the request to
+     * @param data - Parameters to send in the URL, represented as a JSON object
+     * @param options - Options object for configurations you want to use in the fetch request
+     * @returns Resolves to the json object obtained from the request response
+     */
+    static json<T = unknown>(url: string, data?: RequestData, options?: RequestOptions): Promise<T>;
+    /**
+     * Request a Blob from a given URL through a GET request
+     *
+     * @param url - URL to make the request to
+     * @param data - Parameters to send in the URL, represented as a JSON object
+     * @param options - Options object for configurations you want to use in the fetch request
+     * @returns Resolves to the blob obtained from the request response
+     */
+    static blob(url: string, data?: RequestData, options?: RequestOptions): Promise<Blob>;
+}
+//# sourceMappingURL=Request.d.ts.map

package/dist/types/Request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../src/Request.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,OAAO;IACnB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM;IAM3C;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,WAAgB,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAYhG;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAuC5F;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI3F;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI9F;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,WAAgB,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,CAAC,CAAC;IAMvG;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,WAAgB,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;CAK7F"}

package/dist/types/Space.d.ts

@@ -0,0 +1,205 @@
+/**
+ * ==============================
+ * Space
+ * ==============================
+ */
+import { LocalStorage } from './SpaceAdapter/LocalStorage';
+import { SessionStorage } from './SpaceAdapter/SessionStorage';
+import { IndexedDB } from './SpaceAdapter/IndexedDB';
+import { RemoteStorage } from './SpaceAdapter/RemoteStorage';
+import type { SpaceConfiguration, StorageValue, KeyValueResult, UpgradeCallback } from './SpaceAdapter/types';
+/**
+ * List of Adapters Available
+ */
+export declare const SpaceAdapter: {
+    LocalStorage: typeof LocalStorage;
+    SessionStorage: typeof SessionStorage;
+    IndexedDB: typeof IndexedDB;
+    RemoteStorage: typeof RemoteStorage;
+};
+/**
+ * Space adapter type (any of the available adapters)
+ */
+export type SpaceAdapterType = LocalStorage | SessionStorage | IndexedDB | RemoteStorage;
+/**
+ * Space adapter constructor type
+ */
+export type SpaceAdapterConstructor = typeof LocalStorage | typeof SessionStorage | typeof IndexedDB | typeof RemoteStorage;
+/**
+ * Callback function type for space events
+ */
+export type SpaceCallback = (key: string, value: StorageValue) => void;
+/**
+ * Transformation function type
+ */
+export type TransformationFunction = (key: string, value: StorageValue) => StorageValue;
+/**
+ * Transformation configuration
+ */
+export interface Transformation {
+    id: string;
+    get?: TransformationFunction | null;
+    set?: TransformationFunction | null;
+}
+/**
+ * Space provides a simple wrapper for different Storage APIs. It aims to
+ * provide data independence through storage namespaces and versioning, allowing
+ * transparent data formatting and content modifications through versions.
+ */
+export declare class Space {
+    private _configuration;
+    adapter: SpaceAdapterType;
+    callbacks: {
+        create: SpaceCallback[];
+        update: SpaceCallback[];
+        delete: SpaceCallback[];
+    };
+    transformations: Record<string, Transformation>;
+    /**
+     * Create a new Space Object. If no name and version is defined, the global
+     * LocalSpace space is used.
+     *
+     * @param adapter - Space Adapter to use
+     * @param configuration - Configuration object for the space
+     */
+    constructor(adapter?: SpaceAdapterConstructor, configuration?: SpaceConfiguration);
+    /**
+     * Modify the space configuration, it will also be passed down to the adapter
+     * using its configuration() function.
+     *
+     * @param object - Configuration object to set up
+     * @returns Configuration object if no param was passed
+     */
+    configuration(object?: SpaceConfiguration | null): SpaceConfiguration | void;
+    /**
+     * Open the Storage Object to be used depending on the SpaceAdapter
+     *
+     * @returns Promise resolving to this Space
+     */
+    open(): Promise<this>;
+    /**
+     * Store a key-value pair
+     *
+     * @param key - Key with which this value will be saved
+     * @param value - Value to save
+     * @returns Promise with key and value
+     */
+    set(key: string, value: StorageValue): Promise<KeyValueResult>;
+    /**
+     * Update a key-value pair. In difference with the set() method, the update
+     * method will use Object.assign() in the case of objects so no value is lost.
+     *
+     * @param key - Key with which this value will be saved
+     * @param value - Value to save
+     * @returns Promise with key and value
+     */
+    update(key: string, value: StorageValue): Promise<KeyValueResult>;
+    /**
+     * Retrieves a value from storage given its key
+     *
+     * @param key - Key with which the value was saved
+     * @returns Promise resolving to the retrieved value
+     */
+    get(key: string): Promise<StorageValue>;
+    /**
+     * Retrieves all the values in the space in a key-value JSON object
+     *
+     * @returns Promise resolving to all values
+     */
+    getAll(): Promise<Record<string, StorageValue>>;
+    /**
+     * Iterate over every value in the space
+     *
+     * @param callback - A callback function receiving the key and value
+     * @returns Promise resolving when all callbacks have been resolved
+     */
+    each(callback: (key: string, value: StorageValue) => unknown): Promise<unknown[]>;
+    /**
+     * Check if a space contains a given key. Not all adapters may give this information
+     *
+     * @param key - Key to look for
+     * @returns Promise that resolves if key exists
+     */
+    contains(key: string): Promise<void>;
+    /**
+     * Upgrade a Space Version. Not all adapters may provide this functionality
+     *
+     * @param oldVersion - The version of the storage to be upgraded
+     * @param newVersion - The version to be upgraded to
+     * @param callback - Function to transform the old stored values
+     * @returns Promise for the upgrade operation
+     */
+    upgrade(oldVersion: string, newVersion: string, callback: UpgradeCallback): Promise<this>;
+    /**
+     * Rename a Space. Not all adapters may provide this functionality
+     *
+     * @param name - New name to be used
+     * @returns Promise for the rename operation
+     */
+    rename(name: string): Promise<void>;
+    /**
+     * Add a callback function to be run every time a value is created.
+     *
+     * @param callback - Callback Function. Key and Value pair will be sent as parameters.
+     */
+    onCreate(callback: SpaceCallback): void;
+    /**
+     * Add a callback function to be run every time a value is updated.
+     *
+     * @param callback - Callback Function. Key and Value pair will be sent as parameters.
+     */
+    onUpdate(callback: SpaceCallback): void;
+    /**
+     * Add a callback function to be run every time a value is deleted.
+     *
+     * @param callback - Callback Function. Key and Value pair will be sent as parameters.
+     */
+    onDelete(callback: SpaceCallback): void;
+    /**
+     * Add a transformation function to the space.
+     *
+     * @param transformation - Transformation configuration with id, get, and set functions
+     */
+    addTransformation({ id, get, set }: Transformation): void;
+    /**
+     * Remove a transformation function given its id
+     *
+     * @param id - Name or identifier of the transformation to remove
+     */
+    removeTransformation(id: string): void;
+    /**
+     * Get the key that corresponds to a given index in the storage.
+     * Not all adapters may provide this functionality
+     *
+     * @param index - Index to get the key from
+     * @param full - Whether to return the full key name including space id
+     * @returns Promise resolving to the key's name
+     */
+    key(index: number, full?: boolean): Promise<string>;
+    /**
+     * Return all keys stored in the space. Not all adapters may provide this functionality
+     *
+     * @param full - Whether to return the full key name including space id
+     * @returns Promise resolving to array of keys
+     */
+    keys(full?: boolean): Promise<string[]>;
+    /**
+     * Delete a value from the space given its key
+     *
+     * @param key - Key of the item to delete
+     * @returns Promise that resolves after deletion
+     */
+    remove(key: string): Promise<void>;
+    /**
+     * Clear the entire space
+     *
+     * @returns Promise for the clear operation
+     */
+    clear(): Promise<void>;
+}
+export { LocalStorage } from './SpaceAdapter/LocalStorage';
+export { SessionStorage } from './SpaceAdapter/SessionStorage';
+export { IndexedDB } from './SpaceAdapter/IndexedDB';
+export { RemoteStorage } from './SpaceAdapter/RemoteStorage';
+export type { SpaceConfiguration, StorageValue, KeyValueResult, UpgradeCallback } from './SpaceAdapter/types';
+//# sourceMappingURL=Space.d.ts.map

package/dist/types/Space.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Space.d.ts","sourceRoot":"","sources":["../../src/Space.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE9G;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;CAKxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,cAAc,GAAG,SAAS,GAAG,aAAa,CAAC;AAEzF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,YAAY,GAAG,OAAO,cAAc,GAAG,OAAO,SAAS,GAAG,OAAO,aAAa,CAAC;AAE5H;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,KAAK,YAAY,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACpC,GAAG,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACpC;AAED;;;;GAIG;AACH,qBAAa,KAAK;IACjB,OAAO,CAAC,cAAc,CAAqB;IACpC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,SAAS,EAAE;QACjB,MAAM,EAAE,aAAa,EAAE,CAAC;QACxB,MAAM,EAAE,aAAa,EAAE,CAAC;QACxB,MAAM,EAAE,aAAa,EAAE,CAAC;KACxB,CAAC;IACK,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAEvD;;;;;;OAMG;gBACS,OAAO,GAAE,uBAAmD,EAAE,aAAa,GAAE,kBAAuB;IAkBhH;;;;;;OAMG;IACH,aAAa,CAAC,MAAM,GAAE,kBAAkB,GAAG,IAAW,GAAG,kBAAkB,GAAG,IAAI;IAWlF;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrB;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAgB9D;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAgBjE;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAYvC;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAc/C;;;;;OAKG;IACH,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAUjF;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpC;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAMzF;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAIvC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAIvC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAIvC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,IAAI;IAIzD;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAItC;;;;;;;OAOG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1D;;;;;OAKG;IACH,IAAI,CAAC,IAAI,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAI9C;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASlC;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGtB;AAGD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/types/SpaceAdapter/IndexedDB.d.ts

@@ -0,0 +1,130 @@
+/**
+ * ==============================
+ * IndexedDB Adapter
+ * ==============================
+ */
+import type { IndexedDBConfiguration, StorageValue, KeyValueResult, UpgradeCallback } from './types';
+/**
+ * The IndexedDB Adapter provides the Space Class the ability to interact
+ * with the IndexedDB API found in most modern browsers.
+ */
+export declare class IndexedDB {
+    name: string;
+    version: string;
+    store: string;
+    props: IDBObjectStoreParameters;
+    index: Record<string, {
+        name: string;
+        field: string;
+        props?: IDBIndexParameters;
+    }>;
+    keyPath: string;
+    numericVersion: number;
+    upgrades: Record<string, UpgradeCallback<IndexedDB>>;
+    storage: IDBDatabase | Promise<IDBDatabase> | undefined;
+    /**
+     * Create a new IndexedDB. Differently from Local and Session Storages, the
+     * IndexedDB Adapter requires a mandatory name, version and store name.
+     *
+     * @param configuration - Configuration Object for the Adapter
+     */
+    constructor({ name, version, store, props, index }: IndexedDBConfiguration);
+    /**
+     * Modify the configuration
+     *
+     * @param config - Configuration object to set up
+     */
+    configuration(config: IndexedDBConfiguration): void;
+    /**
+     * Open the Storage Object
+     *
+     * @returns Promise resolving to this adapter
+     */
+    open(): Promise<this>;
+    /**
+     * Store a key-value pair. Because of the nature of IndexedDB,
+     * stored values must be JSON objects.
+     *
+     * @param key - Key with which this value will be saved
+     * @param value - Value to save
+     * @returns Promise with key and value
+     */
+    set(key: string | null | undefined, value: StorageValue): Promise<KeyValueResult>;
+    /**
+     * Update a key-value pair. The update method will use Object.assign()
+     * in the case of objects so no value is lost.
+     *
+     * @param key - Key with which this value will be saved
+     * @param value - Value to save
+     * @returns Promise with key and value
+     */
+    update(key: string, value: StorageValue): Promise<KeyValueResult>;
+    /**
+     * Retrieves a value from storage given its key
+     *
+     * @param key - Key with which the value was saved
+     * @returns Promise resolving to the retrieved value
+     */
+    get(key: string): Promise<StorageValue>;
+    /**
+     * Retrieves all the values in the space in a key-value JSON object
+     *
+     * @returns Promise resolving to all values
+     */
+    getAll(): Promise<Record<string, StorageValue>>;
+    /**
+     * Check if the space contains a given key.
+     *
+     * @param key - Key to look for
+     * @returns Promise that resolves if key exists
+     */
+    contains(key: string): Promise<void>;
+    /**
+     * Upgrade a Space Version. Upgrades must be declared before the open()
+     * method is executed.
+     *
+     * @param oldVersion - The version to be upgraded
+     * @param newVersion - The version to be upgraded to
+     * @param callback - Function to transform the old stored values
+     * @returns Promise
+     */
+    upgrade(oldVersion: string, newVersion: string, callback: UpgradeCallback<IndexedDB>): Promise<void>;
+    /**
+     * Helper for the upgrade progress by executing callbacks in order
+     */
+    private _upgrade;
+    /**
+     * Renaming the space is not possible with the IndexedDB adapter therefore
+     * this function always gets rejected.
+     *
+     * @returns Promise rejection
+     */
+    rename(): Promise<never>;
+    /**
+     * Getting a key by its index is not possible in this adapter, therefore this
+     * function always gets rejected.
+     *
+     * @returns Promise rejection
+     */
+    key(): Promise<never>;
+    /**
+     * Return all keys stored in the space.
+     *
+     * @returns Promise resolving to array of keys
+     */
+    keys(): Promise<string[]>;
+    /**
+     * Delete a value from the space given its key
+     *
+     * @param key - Key of the item to delete
+     * @returns Promise resolving to the value of the deleted object
+     */
+    remove(key: string): Promise<StorageValue>;
+    /**
+     * Clear the entire space
+     *
+     * @returns Promise for the clear operation
+     */
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=IndexedDB.d.ts.map

package/dist/types/SpaceAdapter/IndexedDB.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDB.d.ts","sourceRoot":"","sources":["../../../src/SpaceAdapter/IndexedDB.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAErG;;;GAGG;AACH,qBAAa,SAAS;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,wBAAwB,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,kBAAkB,CAAA;KAAE,CAAC,CAAC;IACnF,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IAE/D;;;;;OAKG;gBACS,EAAE,IAAS,EAAE,OAAY,EAAE,KAAU,EAAE,KAAU,EAAE,KAAU,EAAE,EAAE,sBAAsB;IAiBnG;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAMnD;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA+ErB;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,YAAO,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IA0B5E;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAqBjE;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAuBvC;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAyB/C;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpC;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpG;;OAEG;IACH,OAAO,CAAC,QAAQ;IAUhB;;;;;OAKG;IACH,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC;IAIxB;;;;;OAKG;IACH,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC;IAIrB;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBzB;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAkB1C;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAiBtB"}