kinto/lib/adapters/base.d.ts

An Offline-First JavaScript client for Kinto.

import { RecordStatus } from "../types";
export interface StorageProxy<T extends {
    id: string;
    last_modified?: number;
    _status?: RecordStatus;
}> {
    create: (record: T) => void;
    update: (record: T & {
        id: string;
    }) => any;
    delete: (id: string) => void;
    get: (id: string) => T | undefined;
}
export declare abstract class AbstractBaseAdapter<B extends {
    id: string;
    last_modified?: number;
    _status?: RecordStatus;
}> {
    abstract clear(): Promise<void>;
    abstract execute<T>(callback: (proxy: StorageProxy<B>) => T, options: {
        preload: string[];
    }): Promise<T>;
    abstract get(id: string): Promise<any>;
    abstract list(params: {
        filters?: {
            [key: string]: any;
        };
        order?: string;
    }): Promise<any[]>;
    abstract saveLastModified(lastModified?: number | null): Promise<number | null>;
    abstract getLastModified(): Promise<number | null>;
    abstract importBulk(records: B[]): Promise<B[]>;
    abstract loadDump(records: B[]): Promise<B[]>;
    abstract saveMetadata(metadata: {
        [key: string]: any;
    } | null): Promise<{
        [key: string]: any;
    } | null>;
    abstract getMetadata<T>(): Promise<T>;
}
/**
 * Base db adapter.
 *
 * @abstract
 */
export default class BaseAdapter<B extends {
    id: string;
    last_modified?: number;
    _status?: RecordStatus;
}> implements AbstractBaseAdapter<B> {
    /**
     * Deletes every records present in the database.
     *
     * @abstract
     * @return {Promise}
     */
    clear(): Promise<void>;
    /**
     * Executes a batch of operations within a single transaction.
     *
     * @abstract
     * @param  {Function} callback The operation callback.
     * @param  {Object}   options  The options object.
     * @return {Promise}
     */
    execute<T>(callback: (proxy: StorageProxy<B>) => T, options?: {
        preload: string[];
    }): Promise<T>;
    /**
     * Retrieve a record by its primary key from the database.
     *
     * @abstract
     * @param  {String} id The record id.
     * @return {Promise}
     */
    get(id: string): Promise<any>;
    /**
     * Lists all records from the database.
     *
     * @abstract
     * @param  {Object} params  The filters and order to apply to the results.
     * @return {Promise}
     */
    list(params?: {
        filters?: {
            [key: string]: any;
        };
        order?: string;
    }): Promise<any[]>;
    /**
     * Store the lastModified value.
     *
     * @abstract
     * @param  {Number}  lastModified
     * @return {Promise}
     */
    saveLastModified(lastModified?: number | null): Promise<number | null>;
    /**
     * Retrieve saved lastModified value.
     *
     * @abstract
     * @return {Promise}
     */
    getLastModified(): Promise<number | null>;
    /**
     * Load records in bulk that were exported from a server.
     *
     * @abstract
     * @param  {Array} records The records to load.
     * @return {Promise}
     */
    importBulk(records: B[]): Promise<B[]>;
    /**
     * Load a dump of records exported from a server.
     *
     * @deprecated Use {@link importBulk} instead.
     * @abstract
     * @param  {Array} records The records to load.
     * @return {Promise}
     */
    loadDump(records: B[]): Promise<B[]>;
    saveMetadata(metadata: {
        [key: string]: any;
    } | null): Promise<{
        [key: string]: any;
    } | null>;
    getMetadata<T>(): Promise<T>;
}