epps/dist/types/store.d.ts

Enhances Pinia stores with advanced features such as persistence, encryption, and store extension. Simplifies state management and ensures data security for Vue.js and Nuxt applications.

import type { AnyObject, SearchCollectionCriteria } from ".";
import type { _StoreWithGetters, PiniaCustomProperties, PiniaCustomStateProperties, Store, SubscriptionCallback } from "pinia";
import type { PersistOptions } from "../plugins/extendedState";
import type { Ref } from "vue";
export type AugmentStore<T> = Store & T;
export type AugmentOptionApiStore<TStore, TState> = Store & TStore & TState & OptionApiStore<TState> & PiniaCustomProperties & PiniaCustomStateProperties & _StoreWithGetters<TState>;
type CustomStore = Store & PiniaCustomProperties;
type OptionApiStore<TState> = {
    $patch: (item: Partial<TState>) => void;
    $reset: () => void;
    $state: TState;
    $subscribe: (callback: SubscriptionCallback<TState>) => void;
};
type PartialStore<TStore, TState> = Partial<TStore> & Partial<TState>;
type StdStatePropertyValue = AnyObject | boolean | null | number | string | undefined;
export type StatePropertyValue = StdStatePropertyValue | Ref<StdStatePropertyValue> | StdStatePropertyValue[] | Ref<StdStatePropertyValue[]> | Ref<StdStatePropertyValue>[];
/**
 * - -- | Collection Store | -- -
 */
export interface CollectionState<T> {
    items: T[];
}
export interface CollectionStoreMethods {
    addItem: (item: AnyObject) => void;
    getItem: (criteria: SearchCollectionCriteria) => AnyObject | undefined;
    getItems: (criteria?: SearchCollectionCriteria) => AnyObject[];
    removeItem: (item: AnyObject) => void;
    setItems: <T>(items: T[]) => void;
    updateItem: (updatedItem: AnyObject, oldItem?: AnyObject) => void;
}
/**
 * - -- | Persit Store | -- -
 */
export interface PersistedState {
    excludedKeys?: string[];
    isEncrypted?: boolean;
    isLoading?: boolean;
    persist: boolean;
    persistedPropertiesToEncrypt?: string[];
    watchMutation?: boolean;
}
export interface PersistedStore {
    persistState: () => void;
    remember: () => Promise<void>;
    removePersistedState: () => void;
    stateIsEmpty?: () => boolean;
    stopWatch: () => void;
    watch: () => void;
}
type PartialPersistedStore<TStore, TState> = Partial<TStore> & Partial<TState> & Partial<PersistedState> & Partial<PersistedStore>;
/**
 * - -- | Extends Store | -- -
 */
export type DefineEppsStore<TStore, TState> = (args?: any) => PartialPersistedStore<TStore, TState> & CustomStore;
export type DefineEppsStoreOptionApi<TStore, TState> = (args?: any) => PartialPersistedStore<TStore, TState> & CustomStore & Partial<OptionApiStore<TState>>;
export type DefineExtendedStore<TStore, TState> = (args?: any) => PartialStore<TStore, TState> & CustomStore;
export type DefineExtendedStoreOptionApi<TStore, TState> = (args?: any) => PartialStore<TStore, TState> & CustomStore & OptionApiStore<TState>;
export interface ExtendedState extends PersistOptions {
    actionsToExtends?: string[] | Ref<string[] | undefined>;
    isExtended?: boolean | Ref<boolean | undefined>;
    isOptionApi?: boolean | Ref<boolean | undefined>;
    parentsStores?: () => Store[] | EppsStore<AnyObject, AnyObject>[];
}
export type ExtendState<T, I> = T & I & ExtendedState;
export type ExtendedStore<TStore, TState> = TStore & TState & CustomStore;
export type EppsStore<TStore, TState> = ExtendedStore<TStore, TState> & PersistedState & PersistedStore;
export type EppsStoreMethods = Store & PersistedStore & {
    parentsStores: () => Array<Store | EppsStore<AnyObject, AnyObject>>;
};
export {};