@uttori/storage-provider-json-memory/dist/storage-provider.d.ts

Uttori storage provider using JavaScript objects in memory.

export default StorageProvider;
/**
 * The document object we store, with only the minimum methods we access listed.
 */
export type UttoriDocument = {
    /**
     * The unique identifier for the document.
     */
    slug: string;
    /**
     * The creation date of the document.
     */
    createDate?: number;
    /**
     * The last date the document was updated.
     */
    updateDate?: number;
};
/**
 * The configuration object for the StorageProvider.
 */
export type StorageProviderConfig = {
    /**
     * Should update times be marked at the time of edit.
     */
    updateTimestamps?: boolean;
    /**
     * Should history entries be created.
     */
    useHistory?: boolean;
    /**
     * The events to listen for.
     */
    events?: Record<string, string[]>;
};
/**
 * @typedef UttoriDocument The document object we store, with only the minimum methods we access listed.
 * @property {string} slug The unique identifier for the document.
 * @property {number} [createDate] The creation date of the document.
 * @property {number} [updateDate] The last date the document was updated.
 */
/**
 * @typedef StorageProviderConfig The configuration object for the StorageProvider.
 * @property {boolean} [updateTimestamps] Should update times be marked at the time of edit.
 * @property {boolean} [useHistory] Should history entries be created.
 * @property {Record<string, string[]>} [events] The events to listen for.
 */
/**
 * Storage for Uttori documents using JSON objects in memory.
 * @property {UttoriDocument[]} documents - The collection of documents.
 * @property {object} history - The collection of document histories indexes.
 * @property {object} histories - The collection of document revisions by index.
 * @example <caption>Init StorageProvider</caption>
 * const storageProvider = new StorageProvider();
 * @class
 */
declare class StorageProvider {
    /**
     * Creates an instance of StorageProvider.
     * @param {StorageProviderConfig} [config] - A configuration object.
     * @class
     */
    constructor(config?: StorageProviderConfig);
    config: {
        /**
         * Should update times be marked at the time of edit.
         */
        updateTimestamps: boolean;
        /**
         * Should history entries be created.
         */
        useHistory: boolean;
        /**
         * The events to listen for.
         */
        events?: Record<string, string[]>;
    };
    /** @type {Record<string, UttoriDocument>} The collection of documents where the slug is the key and the value is the document. */
    documents: Record<string, UttoriDocument>;
    /** @type {Record<string, string[]>} The collection of document histories indexes. */
    history: Record<string, string[]>;
    /** @type {Record<string, UttoriDocument>} The collection of document revisions by timestamp. */
    histories: Record<string, UttoriDocument>;
    /**
     * Returns all documents.
     * @returns {Promise<Record<string, UttoriDocument>>} All documents.
     * @example
     * ```js
     * storageProvider.all();
     * ➜ { 'first-document': { slug: 'first-document', ... }, ... }
     * ```
     */
    all: () => Promise<Record<string, UttoriDocument>>;
    /**
     * Returns all documents matching a given query.
     * @param {string} query - The conditions on which documents should be returned.
     * @returns {Promise<number | UttoriDocument[]>} The items matching the supplied query.
     */
    getQuery: (query: string) => Promise<number | UttoriDocument[]>;
    /**
     * Returns a document for a given slug.
     * @param {string} slug - The slug of the document to be returned.
     * @returns {Promise<UttoriDocument|undefined>} The returned UttoriDocument.
     */
    get: (slug: string) => Promise<UttoriDocument | undefined>;
    /**
     * Returns the history of edits for a given slug.
     * @param {string} slug - The slug of the document to get history for.
     * @returns {Promise<string[]>} The returned history object.
     */
    getHistory: (slug: string) => Promise<string[]>;
    /**
     * Returns a specifc revision from the history of edits for a given slug and revision timestamp.
     * @param {object} params - The params object.
     * @param {string} params.slug - The slug of the document to be returned.
     * @param {string|number} params.revision - The unix timestamp of the history to be returned.
     * @returns {Promise<UttoriDocument|undefined>} The returned revision of the document.
     */
    getRevision: ({ slug, revision }: {
        slug: string;
        revision: string | number;
    }) => Promise<UttoriDocument | undefined>;
    /**
     * Saves a document to internal array.
     * @param {UttoriDocument} document - The document to be added to the collection.
     */
    add: (document: UttoriDocument) => Promise<void>;
    /**
     * Updates a document and saves to memory.
     * @private
     * @param {object} params - The params object.
     * @param {UttoriDocument} params.document - The document to be updated in the collection.
     * @param {string} params.originalSlug - The original slug identifying the document, or the slug if it has not changed.
     */
    private updateValid;
    /**
     * Updates a document and figures out how to save to memory.
     * Calling with a new document will add that document.
     * @param {object} params - The params object.
     * @param {UttoriDocument} params.document - The document to be updated in the collection.
     * @param {string} params.originalSlug - The original slug identifying the document, or the slug if it has not changed.
     */
    update: ({ document, originalSlug }: {
        document: UttoriDocument;
        originalSlug: string;
    }) => Promise<void>;
    /**
     * Removes a document from memory.
     * @param {string} slug - The slug identifying the document.
     */
    delete: (slug: string) => Promise<void>;
    /**
     * Resets to the initial state.
     */
    reset(): void;
    /**
     * Updates History for a given slug, renaming the key and history key as needed.
     * @param {object} params - The params object.
     * @param {string} params.slug - The slug of the document to update history for.
     * @param {UttoriDocument} params.content - The revision of the document to be saved.
     * @param {string} [params.originalSlug] - The original slug identifying the document, or the slug if it has not changed.
     */
    updateHistory: ({ slug, content, originalSlug }: {
        slug: string;
        content: UttoriDocument;
        originalSlug?: string;
    }) => Promise<void>;
}
//# sourceMappingURL=storage-provider.d.ts.map