pinia-plugin-subscription 0.2.1 → 1.0.0-beta.1

package/dist/chunks/Store-DHUAJv-P.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Store-DHUAJv-P.js","sources":["../../src/core/PluginSubscriber.ts","../../src/utils/store.ts","../../src/utils/validation/index.ts","../../src/core/Store.ts","../../src/utils/constantes.ts"],"sourcesContent":["import Store from \"./Store\";\nimport type { PiniaPluginContext, Store as PiniaStore } from \"pinia\";\nimport type { AnyObject } from \"../types\";\nimport type {\n    PluginExecutionOptions,\n    PluginHydrationScheduler,\n    PluginSubscriber as PluginSubscriberInterface,\n    PluginSubscriptions,\n    StoreClassConstructorParams,\n    StoreMutationSubscription,\n    StoreOnActionSubscription\n} from \"../types/plugin\";\nimport type Tracer from \"../system/Tracer\";\n\n\n\ntype CreateInstance<Instance = Store> = (store: PiniaStore, options: unknown) => Instance | undefined\n\n\n/**\n * Type definition for the function used to create an instance of a store.\n * @template Instance The type of the store instance, defaulting to the base Store class.\n * @param store The Pinia store for which the instance is being created.\n * @param options Additional options for creating the store instance.\n * @returns The created store instance or undefined if creation fails.\n */\nexport default abstract class PluginSubscriber<Instance extends Store> implements PluginSubscriberInterface {\n    private _createInstance: CreateInstance\n    private _name: string\n    private _pluginOptions?: StoreClassConstructorParams\n    private _storeInstance?: Instance\n    /** Callback function to reset the store instance, if needed. */\n    protected _resetStoreCallback?: (store?: PiniaStore) => void\n    private _storeOnActionSubscription?: StoreOnActionSubscription\n    private _storeMutationSubscription?: StoreMutationSubscription\n    private _subscriptions?: PluginSubscriptions\n    /**\n     * Called when the plugin subscriber has been created for a specific store.\n     * This callback can be used to perform any initialization or setup required for the plugin subscriber.\n     */\n    protected pluginCreated?: (store: PiniaStore) => void\n    /** Options for the plugin subscriber's execution. */\n    public execution?: PluginExecutionOptions\n    /** Scheduler for handling the hydration process of the plugin subscriber. */\n    public hydrationScheduler?: PluginHydrationScheduler\n\n\n    get name(): string {\n        return this._name;\n    }\n\n    get storeInstance(): Instance | undefined {\n        return this._storeInstance\n    }\n\n    get pluginOptions(): StoreClassConstructorParams | undefined {\n        return this._pluginOptions;\n    }\n\n    set pluginOptions(options: StoreClassConstructorParams | undefined) {\n        this._pluginOptions = options;\n    }\n\n    get resetStoreCallback(): ((store?: PiniaStore) => void) | undefined {\n        return this._resetStoreCallback as ((store?: PiniaStore) => void) | undefined;\n    }\n\n    get storeOnActionSubscription(): StoreOnActionSubscription | undefined {\n        return this._storeOnActionSubscription;\n    }\n\n    get storeMutationSubscription(): StoreMutationSubscription | undefined {\n        return this._storeMutationSubscription;\n    }\n\n    get subscriptions(): PluginSubscriptions | undefined {\n        return this._subscriptions\n    }\n\n    set subscriptions(subscriptions: PluginSubscriptions) {\n        this._subscriptions = subscriptions\n    }\n\n\n    constructor(pluginName: string, createInstanceFunction: CreateInstance) {\n        this._name = pluginName\n        this._createInstance = createInstanceFunction\n    }\n\n    /**\n     * Called after the store has been hydrated.\n     * @param context The Pinia plugin context containing the store and options.\n     * @returns A promise that resolves when the post-hydration process is complete, or void if synchronous.\n     */\n    public afterHydration(context: PiniaPluginContext): void | Promise<void> {\n        return\n    }\n\n    /**\n     * Called when the plugin subscriber needs to hydrate its state.\n     * @param context The Pinia plugin context containing the store and options.\n     * @returns A promise that resolves when the hydration process is complete, or void if synchronous.\n     */\n    public hydrate(context: PiniaPluginContext): void | Promise<void> {\n        return\n    }\n\n    /**\n     * Invokes the plugin subscriber with the given context and optional tracer creation function.\n     * @param context The Pinia plugin context containing the store and options.\n     * @param createTracer Optional function to create a tracer for the plugin.\n     * @returns True if the plugin was successfully invoked, otherwise false.\n     */\n    public invoke({ store, options }: PiniaPluginContext, createTracer?: (name: string) => Tracer): boolean {\n        this._storeInstance = this._createInstance(store, { ...options, ...this.pluginOptions, createTracer }) as Instance\n\n        if (!this._storeInstance) {\n            return false\n        }\n\n        this._subscriptions = this._storeInstance.getSubscriptions()\n        this._storeMutationSubscription = this._storeInstance.storeSubscribe\n        this._storeOnActionSubscription = this._storeInstance.onAction\n\n        if (this.pluginCreated) {\n            this.pluginCreated(store)\n        }\n\n        return true\n    }\n}","import { defineStore } from \"pinia\"\nimport type {\n    DefineSetupStoreOptions,\n    DefineStoreOptions,\n    SetupStoreDefinition,\n    StateTree,\n    Store,\n    StoreDefinition,\n    _ExtractActionsFromSetupStore,\n    _ExtractGettersFromSetupStore,\n    _ExtractStateFromSetupStore,\n    _GettersTree\n} from \"pinia\"\nimport type { AnyObject } from \"../types\"\nimport type {\n    DefineAStoreDefinition,\n    DefineAStoreSetupContext,\n    EmptyExtensions,\n    StoreOptions\n} from \"../types/store\"\nimport type { PluginStoreOptions } from \"../types/plugin\"\n\n\nexport const itemState = {\n    '@id': undefined,\n    id: undefined\n}\n\ntype DefineAStoreSetup<SS, TExtraExtensions extends Record<string, unknown> = EmptyExtensions> =\n    (ctx: DefineAStoreSetupContext<SS, TExtraExtensions>) => SS\n\n/**\n * Options parameter of pinia's `defineStore()` for setup stores, derived from\n * the setup function return type.\n */\ntype DefineAStoreSetupOptions<Id extends string, SS> = DefineSetupStoreOptions<\n    Id,\n    _ExtractStateFromSetupStore<SS>,\n    _ExtractGettersFromSetupStore<SS>,\n    _ExtractActionsFromSetupStore<SS>\n>\n\nconst defineAStoreSetupContexts = new WeakMap<object, DefineAStoreSetupContext<AnyObject>>()\nconst defineAStoreSetupContextsById = new Map<string, DefineAStoreSetupContext<AnyObject>>()\nconst setupContextDisposeWrappedStores = new WeakSet<object>()\n\nfunction registerSetupContextCleanupOnDispose(\n    store: AnyObject,\n    id: string\n): void {\n    if (setupContextDisposeWrappedStores.has(store) || typeof store.$dispose !== 'function') {\n        return\n    }\n\n    const originalDispose = store.$dispose as (...args: unknown[]) => unknown\n    store.$dispose = (...args: unknown[]) => {\n        defineAStoreSetupContexts.delete(store)\n        defineAStoreSetupContextsById.delete(id)\n        return originalDispose.apply(store, args)\n    }\n    setupContextDisposeWrappedStores.add(store)\n}\n\n/**\n * Define a store with the setup API. State, getters and actions are inferred\n * from the setup function return, exactly like pinia's `defineStore`, so\n * store members are listed by IDEs and action prototypes are preserved.\n * @template Id The type of the store identifier.\n * @template SS The type of the setup function return.\n * @param id The unique identifier for the store.\n * @param storeDefinition The setup function defining the store.\n * @param options Optional store options.\n * @returns The defined store.\n */\nexport function defineAStore<Id extends string, SS>(\n    id: Id,\n    storeDefinition: (ctx?: DefineAStoreSetupContext<AnyObject>) => SS,\n    options?: StoreOptions\n): SetupStoreDefinition<Id, SS>\n/**\n * Define a store with the options API, mirroring pinia's `defineStore` inference.\n * @template Id The type of the store identifier.\n * @template S The type of the store's state.\n * @template G The type of the store's getters.\n * @template A The type of the store's actions.\n * @param id The unique identifier for the store.\n * @param storeDefinition The store options definition.\n * @param options Optional store options.\n * @returns The defined store.\n */\nexport function defineAStore<Id extends string, S extends StateTree = {}, G extends _GettersTree<S> = {}, A = {}>(\n    id: Id,\n    storeDefinition: Omit<DefineStoreOptions<Id, S, G, A>, 'id'>,\n    options?: StoreOptions\n): StoreDefinition<Id, S, G, A>\n/**\n * Define a store with explicit store/state types, e.g. when plugins augment\n * the store with members not returned by the setup function.\n * @template Sto The type of the store.\n * @template Sta The type of the store's state.\n * @param id The unique identifier for the store.\n * @param storeDefinition The store definition, either as an options object or a setup function.\n * @param options Optional store options.\n * @returns The defined store.\n */\nexport function defineAStore<Sto, Sta>(\n    id: string,\n    storeDefinition:\n        | Omit<DefineStoreOptions<string, StateTree & Sta, AnyObject, Partial<Sto>>, 'id'>\n        | ((ctx?: DefineAStoreSetupContext<Sto & Sta>) => AnyObject),\n    options?: StoreOptions\n): DefineAStoreDefinition<Sto, Sta>\nexport function defineAStore(\n    id: string,\n    storeDefinition:\n        | Omit<DefineStoreOptions<string, StateTree, AnyObject, AnyObject>, 'id'>\n        | DefineAStoreSetup<AnyObject>,\n    options?: StoreOptions\n): StoreDefinition {\n    const storeOptions: PluginStoreOptions = options ? { storeOptions: options } : {} as PluginStoreOptions\n\n    return (typeof storeDefinition === 'function'\n        ? defineAStoreSetup(\n            id,\n            storeDefinition as DefineAStoreSetup<AnyObject>,\n            storeOptions\n        )\n        : defineAStoreOptionApi(\n            id,\n            storeDefinition,\n            storeOptions\n        )) as StoreDefinition\n}\n\n/**\n * Define a store with a required, fully typed setup context. State, getters\n * and actions are inferred from the setup function return.\n * @template Id The type of the store identifier.\n * @template SS The type of the setup function return.\n * @template TExtraExtensions The type of the store's extra extensions.\n * @param id The unique identifier for the store.\n * @param storeDefinition The setup function defining the store.\n * @param options Optional store options.\n * @returns The defined store with setup context.\n */\nexport function defineAStoreCtx<Id extends string, SS, TExtraExtensions extends Record<string, unknown> = EmptyExtensions>(\n    id: Id,\n    storeDefinition: (ctx: DefineAStoreSetupContext<AnyObject, TExtraExtensions>) => SS,\n    options?: StoreOptions\n): SetupStoreDefinition<Id, SS>\n/**\n * Define a store with a setup context and explicit store/state types, e.g.\n * when plugins augment the store with members not returned by the setup function.\n * @template Sto The type of the store.\n * @template Sta The type of the store's state.\n * @template TExtraExtensions The type of the store's extra extensions.\n * @param id The unique identifier for the store.\n * @param storeDefinition The setup function defining the store.\n * @param options Optional store options.\n * @returns The defined store with setup context.\n */\nexport function defineAStoreCtx<Sto, Sta, TExtraExtensions extends Record<string, unknown> = EmptyExtensions>(\n    id: string,\n    storeDefinition: (ctx: DefineAStoreSetupContext<Sto & Sta, TExtraExtensions>) => AnyObject,\n    options?: StoreOptions\n): DefineAStoreDefinition<Sto, Sta>\nexport function defineAStoreCtx(\n    id: string,\n    storeDefinition: DefineAStoreSetup<AnyObject, any>,\n    options?: StoreOptions\n): StoreDefinition {\n    const storeOptions: PluginStoreOptions = options\n        ? { storeOptions: { ...options, enhancedStore: true } }\n        : { storeOptions: { enhancedStore: true } } as PluginStoreOptions\n\n    return defineAStoreSetup(\n        id,\n        storeDefinition,\n        storeOptions\n    ) as StoreDefinition\n}\n\nexport function defineAStoreSetup<Id extends string, SS>(\n    id: Id,\n    storeDefinition: DefineAStoreSetup<SS>,\n    options: PluginStoreOptions\n): SetupStoreDefinition<Id, SS> {\n    const setupContext: DefineAStoreSetupContext<SS> = {\n        id,\n        extensions: {}\n    }\n\n    const shouldStoreSetupContext = options?.storeOptions?.enhancedStore === true\n\n    // `storeOptions` augments pinia's DefineStoreOptionsBase (see createPlugin.ts);\n    // the assertion stays valid in compilation units where the augmentation is not loaded.\n    const useStore = defineStore(\n        id,\n        () => storeDefinition(setupContext),\n        options as unknown as DefineAStoreSetupOptions<Id, SS>\n    )\n\n    return Object.assign(((...args: Parameters<typeof useStore>) => {\n        if (shouldStoreSetupContext) {\n            defineAStoreSetupContextsById.set(id, setupContext as DefineAStoreSetupContext<AnyObject>)\n        }\n\n        const store = useStore(...args)\n\n        if (shouldStoreSetupContext) {\n            defineAStoreSetupContexts.set(store, setupContext as DefineAStoreSetupContext<AnyObject>)\n            defineAStoreSetupContextsById.delete(id)\n            registerSetupContextCleanupOnDispose(store as AnyObject, id)\n        }\n\n        return store\n    }) as typeof useStore, useStore)\n}\n\nexport function defineAStoreOptionApi<Id extends string, S extends StateTree = {}, G extends _GettersTree<S> = {}, A = {}>(\n    id: Id,\n    storeDefinition: Omit<DefineStoreOptions<Id, S, G, A>, 'id'>,\n    options?: PluginStoreOptions\n): StoreDefinition<Id, S, G, A> {\n    if (options) {\n        storeDefinition = { ...storeDefinition, ...(options ?? {}) }\n    }\n\n    return defineStore(id, storeDefinition)\n}\n\nconst deniedFirstChar = new Set<string>(['_', '$'])\n\n/**\n * Check if a property has a denied first character : ['_', '$'].\n * @param property The property name to check.\n * @returns True if the property has a denied first character, false otherwise.\n */\nexport function hasDeniedFirstChar(property: string): boolean {\n    return deniedFirstChar.has(property[0] as string)\n}\n\n/**\n * Get the setup context associated with a store instance (or pending store id).\n * @param store The store instance, or an object exposing the store `$id`.\n * @returns The setup context when the store was defined with `enhancedStore` enabled, undefined otherwise.\n */\nexport function getDefineAStoreSetupContext(store: object): DefineAStoreSetupContext<AnyObject> | undefined {\n    const storeRecord = store as AnyObject\n\n    return defineAStoreSetupContexts.get(store)\n        ?? (typeof storeRecord?.$id === 'string'\n            ? defineAStoreSetupContextsById.get(storeRecord.$id)\n            : undefined)\n}\n\n/**\n * Get the enhanced store from the context.\n * @template TEnhancedStore The type of the enhanced store.\n * @param ctx The context containing the extensions.\n * @returns The enhanced store casted to the specified types.\n */\nexport function getEnhancedStore<TEnhancedStore>(\n    ctx: DefineAStoreSetupContext<TEnhancedStore>\n): TEnhancedStore {\n    const enhancedStore = ctx.extensions.enhancedStore ?? ctx.extensions.extending\n\n    if (!enhancedStore) {\n        throw new Error(`${ctx.id}Store - getEnhancedStore - Error: enhanced store is required`)\n    }\n\n    return enhancedStore\n}\n\n/**\n * Set the enhanced store in context with deprecated alias support.\n * @template TEnhancedStore The type of the enhanced store.\n * @param ctx The context containing the extensions.\n * @param store The store to expose as enhancement.\n */\nexport function setEnhancedStore<TEnhancedStore>(\n    ctx: DefineAStoreSetupContext<TEnhancedStore>,\n    store: TEnhancedStore\n): void {\n    ctx.extensions.enhancedStore = store\n    ctx.extensions.extending = store\n}\n\n/**\n * @deprecated Use getEnhancedStore instead.\n */\nexport function getExtendingStore<TEnhancedStore>(\n    ctx: DefineAStoreSetupContext<TEnhancedStore>\n): TEnhancedStore {\n    console.warn(`${ctx.id}Store - getExtendingStore is deprecated. Use getEnhancedStore instead.`)\n    return getEnhancedStore<TEnhancedStore>(ctx)\n}\n\n/**\n * Get the storage key for a given action and store combination.\n * @param actionName The name of the action.\n * @param store The Pinia store instance.\n * @returns The storage key for the action and store combination.\n */\nexport function getActionStoreKey(actionName: string, store: Store): string {\n    return `${actionName}-${store.$id}`\n}","export function isEmpty(value: any): boolean {\n    if (!value) {\n        return (typeof value === 'boolean' || typeof value === 'number') ? false : true\n    }\n\n    if (Array.isArray(value)) {\n        return value.length === 0\n    }\n\n    if (typeof value === 'object') {\n        return Object.keys(value).length === 0\n    }\n\n    if (typeof value === 'string') {\n        return value.trim() === ''\n    }\n\n    return false\n}","import { isRef, ref, toRef } from \"vue\"\nimport Tracer from \"../system/Tracer\"\nimport { getDefineAStoreSetupContext, hasDeniedFirstChar, setEnhancedStore } from \"../utils/store\"\nimport { isEmpty } from \"../utils/validation\"\nimport { pluginName } from \"../utils/constantes\"\n\nimport type {\n    PluginStoreOptions,\n    PluginSubscriptionOptions,\n    PluginSubscriptions,\n    StoreClassConstructorParams,\n    StoreMutationSubscription,\n    StoreMutationSubscriptionCallback,\n    StoreMutationSubscriptionReturn,\n    StoreOnActionSubscription,\n    StoreOnActionSubscriptionCallback,\n    StoreOnActionSubscriptionReturn\n} from \"../types/plugin\"\nimport type { Store as PiniaStore, StateTree } from \"pinia\"\nimport type { TracePayload } from \"../types/trace\"\nimport type { AnyObject, PluginSubscriberInterface } from \"../types\"\nimport type { StoreOptions, StatePropertyValue } from \"../types/store\"\n\n/**\n * Base class for a Pinia store with enhanced capabilities.\n * Provides structured tracing, plugin subscriptions, and state management utilities.\n * @remarks\n * This class is intended to be extended by specific store implementations\n * that require enhanced capabilities such as structured tracing and plugin subscriptions.\n */\nexport default class Store {\n    protected _className = 'Store'\n    private _createTracer?: PluginSubscriptionOptions['createTracer']\n    private _onAction?: StoreOnActionSubscriptionCallback\n    private _options: StoreOptions\n    private _store: PiniaStore\n    private _storeSubscribe?: StoreMutationSubscriptionCallback\n    private _subscriptions: PluginSubscriptions = {}\n    private _traceOptions: Record<string, boolean> = {\n        /** Indicates whether to add the class name to the namespace for tracing purposes. */\n        addClassNameToLabel: true,\n    }\n    private _tracer?: Tracer\n\n    protected static _requiredKeys?: string[]\n\n    get classNameAddedToTraceNamespace(): boolean {\n        return this._traceOptions.addClassNameToLabel\n    }\n\n    set classNameAddedToTraceNamespace(value: boolean) {\n        this._traceOptions.addClassNameToLabel = value\n    }\n\n    get onAction(): StoreOnActionSubscription | undefined {\n        if (!this._onAction) {\n            return\n        }\n\n        return () => ({\n            store: this.store as PiniaStore,\n            callback: this._onAction\n        }) as StoreOnActionSubscriptionReturn\n    }\n\n    set onAction(onAction: StoreOnActionSubscriptionCallback) {\n        this._onAction = onAction\n    }\n\n    get options(): StoreOptions { return this._options }\n\n    get state(): StateTree { return this._store.$state }\n\n    set state(state: StateTree) { this._store.$state = state }\n\n    get store(): AnyObject { return this._store }\n\n    get storeSubscribe(): StoreMutationSubscription | undefined {\n        if (!this._storeSubscribe) {\n            return\n        }\n\n        return () => ({\n            store: this.store as PiniaStore,\n            callback: this._storeSubscribe\n        }) as StoreMutationSubscriptionReturn\n    }\n\n    set storeSubscribe(storeSubscribe: StoreMutationSubscriptionCallback) {\n        this._storeSubscribe = storeSubscribe\n    }\n\n    /**\n     * Returns the structured trace emitter of this store.\n     * Built lazily so that subclasses overriding `_className` are reflected.\n     */\n    protected get tracer(): Tracer | undefined {\n        if (!this._tracer && this._createTracer) {\n            this._tracer = this._createTracer(pluginName)\n            this._tracer.scope = this.store.$id\n        }\n\n        return this._tracer\n    }\n\n    /**\n     * Constructs a new instance of the store.\n     * @param store The Pinia store instance.\n     * @param options The plugin store options and subscription options.\n     * @remarks\n     * This constructor is typically called by the `customizeStore` static method\n     * to create an instance of the store with the provided Pinia store and options.\n     * @see PluginStoreOptions\n     * @see PluginSubscriptionOptions\n     */\n    constructor(store: PiniaStore, options: StoreClassConstructorParams) {\n        this._options = options.storeOptions\n        this._store = store\n        this.initializeTracer(options)\n\n        if (this._options?.enhancedStore) {\n            const ctx = getDefineAStoreSetupContext(this.store)\n\n            if (ctx) {\n                setEnhancedStore(ctx, this.store)\n            }\n        }\n    }\n\n    /**\n     * Adds a property to the state of this store.\n     * @param name The name of the property to add.\n     * @param value The value of the property to add.\n     */\n    addToState(name: string, value?: StatePropertyValue): void {\n        if (!this.isOptionApi()) {\n            if (!isRef(value)) {\n                value = ref<StatePropertyValue>(value)\n            }\n        }\n\n        this.state[name] = value\n        this.store[name] = toRef(this.state, name)\n    }\n\n    /**\n     * Adds a subscription for a specific plugin to this store.\n     * @param pluginName The name of the plugin for which the subscription is being added.\n     * @param subscription The subscription callback or object to add.\n     * @param options Additional options for the subscription, including subscription options and target stores.\n     */\n    addSubscription(\n        pluginName: string,\n        subscription: PluginSubscriberInterface,\n        options?: { subscriptionOptions?: StoreOptions, stores?: PiniaStore[] }\n    ): void {\n        this._subscriptions[pluginName] = { subscription, ...(options ?? {}) }\n    }\n\n    /**\n     * Called after the store has been hydrated.\n     * @returns A promise that resolves when the post-hydration process is complete, or void if synchronous.\n     */\n    afterHydration(): void | Promise<void> {\n        return\n    }\n\n    /**\n     * Create and return a class instance\n     * @param store \n     * @param options \n     * @template Instance The type of the store instance being created.\n     * @returns The created store instance of type `Instance`, or undefined if the required keys are not present.\n     */\n    static customizeStore<Instance extends Store>(\n        store: PiniaStore,\n        options: PluginStoreOptions & PluginSubscriptionOptions\n    ): Instance | undefined {\n        if (options.storeOptions && this.hasRequiredKeys(options.storeOptions)) {\n            return new this(store, options) as Instance\n        }\n    }\n\n    /**\n     * Retrieves the value of a specific store option.\n     * @param optionName The name of the store option to retrieve.\n     * @returns The value of the specified store option, or undefined if not found.\n     */\n    getOption(optionName: keyof StoreOptions) {\n        return this.options && (this.options as StoreOptions)[optionName]\n    }\n\n    /**\n     * Retrieves the value of a specific state property.\n     * @param propertyName The name of the state property to retrieve.\n     * @returns The value of the specified state property, or undefined if not found.\n     */\n    getStatePropertyValue(propertyName: string) {\n        return this.getValue(this.state[propertyName])\n    }\n\n    /**\n     * Retrieves all plugin subscriptions for this store.\n     * @returns An object containing all plugin subscriptions, or undefined if there are none.\n     */\n    getSubscriptions(): PluginSubscriptions | undefined {\n        if (isEmpty(this._subscriptions)) {\n            return\n        }\n\n        return this._subscriptions\n    }\n\n    /**\n     * Retrieves the actual value from a potentially reactive reference.\n     * @param value The value to unwrap.\n     * @returns The unwrapped value if it is a reactive reference, otherwise the original value.\n     */\n    getValue(value: any) {\n        return value?.__v_isRef ? value.value : value\n    }\n\n    /**\n     * Checks if the given property name has a denied first character.\n     * @param property The property name to check.\n     * @returns True if the property name has a denied first character, otherwise false.\n     */\n    protected hasDeniedFirstChar(property: string): boolean {\n        return hasDeniedFirstChar(property)\n    }\n\n    /**\n     * Checks if the given options object has all the required keys.\n     * @param options The options object to check.\n     * @returns True if all required keys are present, otherwise false.\n     */\n    protected static hasRequiredKeys(options: AnyObject): boolean {\n        return this._requiredKeys !== undefined && this._requiredKeys?.every(requiredKey => !!options[requiredKey])\n    }\n\n    /**\n     * Hydrates the store, potentially performing asynchronous operations.\n     * @returns void or a Promise that resolves when hydration is complete.\n     */\n    hydrate(): void | Promise<void> {\n        return\n    }\n\n    /**\n     * Initializes the tracer for plugin subscriptions if the createTracer option is provided.\n     * @param options The plugin subscription options containing the createTracer function.\n     */\n    private initializeTracer(options: PluginSubscriptionOptions) {\n        this._createTracer = options?.createTracer\n    }\n\n    /**\n     * Checks if the store is using the Options API.\n     * @returns True if the store is using the Options API, otherwise false.\n     */\n    isOptionApi(): boolean { return this.store._isOptionsAPI }\n\n    /**\n     * Checks if the state object has the specified property.\n     * @param property The property name to check.\n     * @returns True if the state object has the property, otherwise false.\n     */\n    stateHas(property: string): boolean { return Object.prototype.hasOwnProperty.call(this.state, property) }\n\n    /**\n     * Checks if the store object has the specified property.\n     * @param property The property name to check.\n     * @returns True if the store object has the property, otherwise false.\n     */\n    storeHas(property: string): boolean { return Object.prototype.hasOwnProperty.call(this.store, property) }\n\n    /**\n     * Emits a structured trace event scoped to this store.\n     * Prefer the factory form for `payload`: it is only resolved when consumed.\n     */\n    trace(label: string, payload?: TracePayload, scope?: string, namespace?: string): void {\n        if (this.tracer) {\n            label = this.traceLabelFormatter(label)\n            this.tracer.debug(label, namespace ?? label.toLowerCase(), payload, scope)\n        }\n    }\n\n    /**\n     * Emits a structured error event, or rethrows it when no listener matches.\n     */\n    traceError(label: string, error: unknown, payload?: TracePayload, scope?: string, namespace?: string): void {\n        if (this.tracer) {\n            label = this.traceLabelFormatter(label)\n            this.tracer.error(label, namespace ?? label.toLowerCase(), error, payload, scope)\n        } else {\n            console.error(error)\n        }\n    }\n\n    private traceLabelFormatter(label: string): string {\n        if (this.classNameAddedToTraceNamespace) {\n            label = `${this.constructor.name}:${label}`\n        }\n\n        return label\n    }\n}","export const pluginName: string = 'pinia-plugin-subscription'"],"names":["PluginSubscriber","pluginName","createInstanceFunction","__publicField","options","subscriptions","context","store","createTracer","defineAStoreSetupContexts","defineAStoreSetupContextsById","setupContextDisposeWrappedStores","registerSetupContextCleanupOnDispose","id","originalDispose","args","storeOptions","storeDefinition","defineAStoreSetup","defineAStoreOptionApi","defineAStoreCtx","setupContext","shouldStoreSetupContext","useStore","defineStore","deniedFirstChar","property","getDefineAStoreSetupContext","storeRecord","getEnhancedStore","ctx","enhancedStore","setEnhancedStore","getExtendingStore","getActionStoreKey","actionName","isEmpty","value","Store","onAction","state","storeSubscribe","name","isRef","ref","toRef","pluginName2","subscription","optionName","propertyName","hasDeniedFirstChar","requiredKey","label","payload","scope","namespace","error"],"mappings":";;;;;AA0BA,MAA8BA,EAA8E;AAAA,EAqDxG,YAAIC,GAAcC,GAAoC;AApD9C,IAAAC,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AAEE,IAAAA,EAAA;AACF,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AAAA,IAAAA,EAAA;AAAA,IAAAA,EAAA;AAKE,IAAAA,EAAA;AAwCN,SAAK,QAAAF,GACT,KAAA,kBAAAC;AAAA,EAGA;AAAA,EA1CO,IAAA,OAAA;AAAA,WAAA,KAAA;AAAA,EAEA;AAAA,EAGP,IAAI,gBAAe;AACf,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,gBAAsC;AACtC,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,cAAAE,GAAyD;AACzD,SAAA,iBAAYA;AAAA,EAChB;AAAA,EAEA,IAAI,qBAAc;AACd,WAAK,KAAA;AAAA,EACT;AAAA,EAEA,IAAI,4BAAiE;AACjE,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,4BAAmE;AACnE,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI;AACA,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,cAAAC,GAAiD;AACjD,SAAA,iBAAYA;AAAA,EAChB;AAAA,EASI,eAAKC,GAAA;AAAA,EACT;AAAA,EAAA,QAAAA,GAAA;AAAA,EAAA;AAAA,EAQI,OAAA,EAAA,OAAAC,GAAA,SAAAH,EAAA,GAAAI,GAAA;AACJ,WAAA,KAAA,iBAAA,KAAA,gBAAAD,GAAA,EAAA,GAAAH,GAAA,GAAA,KAAA,eAAA,cAAAI,EAAA,CAAA,GAAA,KAAA,kBAAA,KAAA,iBAAA,KAAA,eAAA,iBAAA,GAAA,KAAA,6BAAA,KAAA,eAAA,gBAOO,kCAA2D,KAAA,eAAA,UAC9D,KAAA,iBACJ,KAAA,cAAAD,CAAA,GAAA,MATA;AAAA,EASA;AAAA;AAAA,MAAAE,IAAA,oBAAA,QAAA,GAQOC,IAAiG,oBAAA,IAAA,GACpGC,IAAoD,oBAAG,QAAS;AAEhE,SAAKC,EAAqBL,GAAAM,GAAA;AACtB,MAAAF,EAAO,IAAAJ,CAAA,KAAA,OAAAA,EAAA,YAAA;AACX;AAGA,QAAAO,IAAKP,EAAA;AACL,EAAAA,EAAA,WAAK,IAAAQ,OAELN,EAAwB,OAAAF,CAAA,GACpBG,EAAwB,OAAAG,CAAA,GAC5BC,EAAA,MAAAP,GAAAQ,CAAA,IAGJJ,EAAA,IAAAJ,CAAA;AACJ;;ACxFA,QAAMS,IAAAZ,IAAA,EAAA,cAAAA,EAAgC,IAAA,CAAA;AACtC,SAAM,OAAAa,KAAA,aAAAC;AAAA,IACNL;AAAA,IAEAI;AAAA,IAIID;AAAA,EACI,IAAAG;AAAA,IACJN;AAAA,IAEAI;AAAA;EAEI;AACA;AACA,SAAAG,KAAuBH,GAAiBb,GAAA;AAC5C,QAAAY,IAAAZ,IAAA,EAAA,cAAA,EAAA,GAAAA,GAAA,eAAA,GAAA,EAAA,IAAA,EAAA,cAAA,EAAA,eAAA,GAAA,EAAA;AACA,SAAAc;AAAA,IACJL;AAAA,IAmDOI;AAAA,IAOHD;AAAA,EAEA;AACM;AACE,SACAE,EAAAL,GAAAI,GAAAb,GAAA;AAAA,QACAiB,IAAA;AAAA;IAGA,YAAA,CAAA;AAAA,EAAA,GAEAC,IAAAlB,GAAA,cAAA,kBAAA,IACJmB,IAAAC;AAAA,IACRX;AAAA,IAkCO,QACHQ,CACA;AAAA,IAGAjB;AAAA,EAIA;AAAO,SACH,OAAA,QAAA,IAAAW,MAAA;AACA,IAAAO,KACAZ,EAAA,IAAAG,GAAAQ,CAAA;AAER,UAAAd,IAAAgB,EAAA,GAAAR,CAAA;AAEO,WAAAO,MAKHb,EAAmD,IAAAF,GAAAc,CAAA,GAC/CX,EAAA,OAAAG,CAAA,KACYN,GAAAM,CAAA;EAOhB,IAAAU,CAAM;AAAW;AACb,SACAJ,EAAsBN,GAAAI,GAAYb,GAAA;AAAA,SAClCA,MACJa,IAAA,EAAA,GAAAA,GAAA,GAAAb,KAAA,CAAA,EAAA,UAGiC;AACzB;AAAyF,MAC7FqB,IAAA,oBAAA,IAAA,CAAA,KAAA,GAAA,CAAA;AAEA,WAAuBC,GAAO;AAE9B,iBAA6B,CAAA,CAAA;AACzB;AACA,SAAAC,EAA8BpB;AAC9B,QAAAqB,IAAArB;AAA2D,SAC/DE,EAAA,IAAAF,CAAA,MAAA,OAAAqB,GAAA,OAAA,WAAAlB,EAAA,IAAAkB,EAAA,GAAA,IAAA;AAEA;AAAO,SACYC,EAAQC,GAAA;AACnC,QAAAC,IAAAD,EAAA,WAAA,iBAAAA,EAAA,WAAA;AAEO,MAAA,CAAAC;AAKH,cAAI,MAAS,GAAAD,EAAA,EAAA,8DAAA;AAEb,SAAAC;AAEA;AACJ,SAAAC,EAAAF,GAAAvB,GAAA;AAEA,EAAAuB,EAAM,WAAA,mBAOCA,EAAA,WAAS,YAAmBvB;AAC/B;AACJ,SAAA0B,EAAAH,GAAA;AAOO,iBAAS,KAAA,GAAAA,EAAA,EAAA,wEAA4F,GAClGD,EAAcC,CAAA;AAEpB;AAIJ,SAAAI,EAAAC,GAAA5B,GAAA;AAQO,SAAS,GAAA4B,CAAA,IACZ5B,EACc,GAAA;AACd;AAGI,SAAA6B,EAAUC,GAAS;AACvB,SAAAA,IAWG,MAAS,QAAAA,CAAA,IAIRA,EAAW,WAAA,IAEnB,OAAAA,KAAA,WAKgB,OAAA,KAAAA,CACZ,EAAA,WACc,IAEd,OAAOA,KAAA,WACXA,EAAA,KAAA,MAAA,KASW,KAlCA,SAAAA,KAAA,aAAA,OAAAA,KAAA;AAmCX;AClTO,MAAApC,IAAiB;AAEhB,MAAAqC,EAAQ;AAAA,ECgFM,YACH/B,GAAKH,GAAA;ADhFpB,IAAAD,EAAA,oBAAA;AAEA,IAAAA,EAAA;AACI,IAAAA,EAAA;AACJ,IAAAA,EAAA;AAEA,IAAAA,EAAA;AACI,IAAAA,EAAA;AACJ,IAAAA,EAAA,wBAAA,CAAA;AAEA,IAAAA,EAAA;MAEA,qBAAA;AAAA,IAEA;AACJ,IAAAA,EAAA;ACsEI,QALoB,KACZ,WAAUC,EAAK,cAAA,KACnB,SAAAG,GACJ,KAAA,iBAAAH,CAAA,GAEI,KAAA,UAAe,eAAmD;AAClE,YAAK0B,IAAAH,EAAkB,KAAA,KAAA;AAC3B,MAAAG,KAAAE,EAAAF,GAAA,KAAA,KAAA;AAAA,IAAA;AAAA,EAAA;AAAA,EC1FG,IAAM,iCAAqB;;ED8BlC;AAAA,EACc,IAAA,+BAAaO,GAAA;AACf,SAAA,cAAA,sBAAAA;AAAA,EACA;AAAA,EACA,IAAA,WAAA;AACA,QAAA,KAAA;oBAGyC;AAAA,QAAA,OAAA,KAAA;AAAA;MAGjD;AAAA,EACQ;AAAA,EAER,aAAiBE,GAAA;AAEjB;EACI;AAAA,EACJ,IAAA,UAAA;AAEA,WAAI,KAAA;AAAA,EACA;AAAA,EACJ,IAAA,QAAA;AAEA,gBAAI,OAAkD;AAAA,EAClD;AAAA,EACI,IAAA,MAAAC,GAAA;AACJ,SAAA,OAAA,SAAAA;AAAA,EAEA;AAAA,EAAc,IACV,QAAO;AAAK,WACZ,KAAU;AAAA,EAAK;AAAA,EAEvB,IAAA,iBAAA;AAEA,QAAI;AAIJ,oBAA4B;AAAA,QAAE,OAAO,KAAK;AAAA,QAAS,UAAA,KAAA;AAAA,MAEnD;AAAA,EAAyB;AAAA,EAA0B,IAAA,eAAAC,GAAA;AAEnD,SAAI,kBAAwBA;AAAA,EAAE;AAAA,EAE9B,IAAI,SAAmB;AAAE,WAAA,CAAA,KAAO,WAAK,KAAA,kBAAO,KAAA,UAAA,KAAA,cAAAxC,CAAA,GAExC,qBAAwD,KAAA,MAAA,MAEpD,KAAA;AAAA,EAAA;AAAA,EAkBJ,WAAKyC,MAAgB;AACjB,IAAA,KAAK,YAAe,KACfC,EAAAN,CAAQ,MACjBA,IAAAO,EAAAP,CAAA,IAGJ,KAAA,MAAAK,CAAA,IAAAL,GAAA,KAAA,MAAAK,CAAA,IAAAG,EAAA,KAAA,OAAAH,CAAA;AAAA,EAAA;AAAA,EAAA,gBAAAI,GAAAC,GAAA3C,GAAA;AAAA,SAAA,eAAA0C,CAAA,IAAA,EAAA,cAAAC,GAAA,GAAA3C,KAAA,CAAA,EAAA;AAAA,EAAA;AAAA,EAAA,iBAAA;AAAA,EAYA;AAAA,EAEI,OAAK,eAASG,GAAAH,GAAA;AACd,QAAAA,EAAK,qBAAwB,gBAAAA,EAAA,YAAA;aAEpB,IAAA,SAAU;AAAA,EAGf;AAAA,EACoC,UACpC4C,GAAA;AACJ,WAAA,KAAA,WAAA,KAAA,QAAAA,CAAA;AAAA,EACJ;AAAA,EAAA,sBAAAC,GAAA;AAAA,WAAA,KAAA,SAAA,KAAA,MAAAA,CAAA,CAAA;AAAA,EAAA;AAAA,EAOA;AACI,QAAI,CAAAb,EAAM,KAAA,cAAe;AAEoB,aACzC,KAAA;AAAA,EAAA;AAAA,EAIJ,SAAKC;AACT,WAAAA,GAAA,YAAAA,EAAA,QAAAA;AAAA,EAAA;AAAA,EAAA,mBAAAX,GAAA;AAAA,WAAAwB,EAAAxB,CAAA;AAAA,EAAA;AAAA,EAQA,uBACIzB,GACA;AAGA,WAAK,KAAA,4BAA+B,KAAA,eAAkB,OAAYkD,MAAG,CAAA,CAAA/C,EAAA+C,CAAA,CAAA;AAAA,EACzE;AAAA,EAAA,UAAA;AAAA,EAAA;AAAA,EAOI,iBAAA/C,GAAA;AACJ,SAAA,gBAAAA,GAAA;AAAA,EAAA;AAAA,EAAA,cAAA;AAAA,WAAA,KAAA,MAAA;AAAA,EAAA;AAAA,EAAA,SAAAsB,GAAA;WASO,OAAA,UACH,eAEoB,KAAA,KAAA,OAAAA,CAAA;AAAA,EACpB;AAAA,EACkC,SAClCA,GAAA;AACJ,WAAA,OAAA,UAAA,eAAA,KAAA,KAAA,OAAAA,CAAA;AAAA,EAAA;AAAA,EAAA,MAAA0B,GAAAC,GAAAC,GAAAC,GAAA;AAAA,IAAA,KAAA,WAAAH,IAAA,KAAA,oBAAAA,CAAA,GAOA,YAAU,MAAgCA,GAAAG,KAAAH,EAAA,YAAA,GAAAC,GAAAC,CAAA;AAAA,EAE1C;AAAA,EAAA,WAAAF,GAAAI,GAAAH,GAAAC,GAAAC,GAAA;AAAA,IAAA,KAAA,UAAAH,IAAA,KAAA,oBAAAA,CAAA,GAAA,KAAA,OAAA,MAAAA,GAAAG,KAAAH,EAAA,YAAA,GAAAI,GAAAH,GAAAC,CAAA,KAQI,QAAO,MAAKE,CAAS;AAAA,EACzB;AAAA,EAAA,oBAAAJ,GAAA;AAAA,WAAA,KAAA,mCAAAA,IAAA,GAAA,KAAA,YAAA,IAAA,IAAAA,CAAA,KAOQA;AAAA,EACA;AAAA;ED7MJd;"}

package/dist/core/PluginSubscriber.d.ts

@@ -1,35 +1,62 @@
 import Store from "./Store";
 import type { PiniaPluginContext, Store as PiniaStore } from "pinia";
-import type { AnyObject } from "../types";
-import type { PluginExecutionOptions, PluginHydrationScheduler, PluginSubscriber as PluginSubscriberInterface, PluginSubscriptions, StoreMutationSubscription, StoreOnActionSubscription } from "../types/plugin";
-import type { Console } from "../types/log";
-type CreateInstance<Instance = Store> = (store: PiniaStore, options: AnyObject, debug: boolean, customConsole?: Console) => Instance | undefined;
+import type { PluginExecutionOptions, PluginHydrationScheduler, PluginSubscriber as PluginSubscriberInterface, PluginSubscriptions, StoreClassConstructorParams, StoreMutationSubscription, StoreOnActionSubscription } from "../types/plugin";
+import type Tracer from "../system/Tracer";
+type CreateInstance<Instance = Store> = (store: PiniaStore, options: unknown) => Instance | undefined;
+/**
+ * Type definition for the function used to create an instance of a store.
+ * @template Instance The type of the store instance, defaulting to the base Store class.
+ * @param store The Pinia store for which the instance is being created.
+ * @param options Additional options for creating the store instance.
+ * @returns The created store instance or undefined if creation fails.
+ */
 export default abstract class PluginSubscriber<Instance extends Store> implements PluginSubscriberInterface {
-    private _console?;
     private _createInstance;
     private _name;
     private _pluginOptions?;
     private _storeInstance?;
+    /** Callback function to reset the store instance, if needed. */
     protected _resetStoreCallback?: (store?: PiniaStore) => void;
     private _storeOnActionSubscription?;
     private _storeMutationSubscription?;
     private _subscriptions?;
+    /**
+     * Called when the plugin subscriber has been created for a specific store.
+     * This callback can be used to perform any initialization or setup required for the plugin subscriber.
+     */
     protected pluginCreated?: (store: PiniaStore) => void;
+    /** Options for the plugin subscriber's execution. */
     execution?: PluginExecutionOptions;
+    /** Scheduler for handling the hydration process of the plugin subscriber. */
     hydrationScheduler?: PluginHydrationScheduler;
-    get console(): Console;
     get name(): string;
     get storeInstance(): Instance | undefined;
-    get pluginOptions(): AnyObject;
-    set pluginOptions(options: AnyObject | undefined);
+    get pluginOptions(): StoreClassConstructorParams | undefined;
+    set pluginOptions(options: StoreClassConstructorParams | undefined);
     get resetStoreCallback(): ((store?: PiniaStore) => void) | undefined;
     get storeOnActionSubscription(): StoreOnActionSubscription | undefined;
     get storeMutationSubscription(): StoreMutationSubscription | undefined;
     get subscriptions(): PluginSubscriptions | undefined;
     set subscriptions(subscriptions: PluginSubscriptions);
-    constructor(pluginName: string, createInstanceFunction: CreateInstance, pluginConsole?: Console);
-    afterHydration(context: PiniaPluginContext, debug: boolean): void | Promise<void>;
-    hydrate(context: PiniaPluginContext, debug: boolean): void | Promise<void>;
-    invoke({ store, options }: PiniaPluginContext, debug: boolean): boolean;
+    constructor(pluginName: string, createInstanceFunction: CreateInstance);
+    /**
+     * Called after the store has been hydrated.
+     * @param context The Pinia plugin context containing the store and options.
+     * @returns A promise that resolves when the post-hydration process is complete, or void if synchronous.
+     */
+    afterHydration(context: PiniaPluginContext): void | Promise<void>;
+    /**
+     * Called when the plugin subscriber needs to hydrate its state.
+     * @param context The Pinia plugin context containing the store and options.
+     * @returns A promise that resolves when the hydration process is complete, or void if synchronous.
+     */
+    hydrate(context: PiniaPluginContext): void | Promise<void>;
+    /**
+     * Invokes the plugin subscriber with the given context and optional tracer creation function.
+     * @param context The Pinia plugin context containing the store and options.
+     * @param createTracer Optional function to create a tracer for the plugin.
+     * @returns True if the plugin was successfully invoked, otherwise false.
+     */
+    invoke({ store, options }: PiniaPluginContext, createTracer?: (name: string) => Tracer): boolean;
 }
 export {};

package/dist/core/PluginSubscription.d.ts

@@ -1,7 +1,6 @@
-import Debug from "../system/Debug";
 import type { PiniaPluginContext } from "pinia";
 import type { PluginSubscriber, PluginSubscriptionOptions, PluginSubscriptions } from "../types/plugin";
-export default class PluginSubscription extends Debug {
+export default class PluginSubscription {
     protected _className: string;
     private _hydrationScheduler;
     private _onActionSubscriptions;
@@ -9,7 +8,6 @@ export default class PluginSubscription extends Debug {
     private _onActionAfterSubscriptions;
     private _onActionOnErrorSubscriptions;
     private _options?;
-    private _pluginDebug?;
     private _resetStoreCallback;
     private _disposedStores;
     private _storeRollbackSnapshotsHandler;
@@ -19,9 +17,10 @@ export default class PluginSubscription extends Debug {
     private _subscriptions;
     private _subscriptionsDelivered;
     private _subscriptionsScheduled;
+    private _tracer?;
     set subscribers(subscribers: PluginSubscriber[]);
     get subscriptions(): PluginSubscriptions[] | undefined;
-    constructor(subscribers: PluginSubscriber[], debugOrOptions?: PluginSubscriptionOptions | string[], pluginOptions?: PluginSubscriptionOptions);
+    constructor(subscribers: PluginSubscriber[], options?: PluginSubscriptionOptions);
     private addOnActionAfterCallback;
     private addOnActionOnErrorCallback;
     private addResetStoreCallback;
@@ -49,7 +48,6 @@ export default class PluginSubscription extends Debug {
      */
     private createRollbackSnapshot;
     private defineCurrentEnvironment;
-    private definePluginDebug;
     private definePluginExecution;
     private defineHydrationScheduler;
     private defineSubscriberKey;
@@ -64,6 +62,14 @@ export default class PluginSubscription extends Debug {
     private executeStoreOnActionSubscription;
     private executeSubscriber;
     private executeSubscriberSafely;
+    private initializeTracer;
+    /**
+     * Invokes the plugin with the given Pinia plugin context, executing all relevant subscribers safely.
+     * @param param0 The Pinia plugin context containing the store and options.
+     * @param param0.store The Pinia store instance.
+     * @param param0.options The options passed to the Pinia store.
+     * @returns void
+     */
     plugin({ store, options }: PiniaPluginContext): void;
     private queueSubscriberExecution;
     private registerStoreCleanup;
@@ -74,4 +80,13 @@ export default class PluginSubscription extends Debug {
     private storeMutationSubscription;
     private subscriptionDelivery;
     private subscriptionDeliverySafely;
+    /**
+     * Emits a structured trace event.
+     * Prefer the factory form for `payload`: it is only resolved when consumed.
+     */
+    private trace;
+    /**
+     * Emits a structured error event, or rethrows it when no listener matches.
+     */
+    private traceError;
 }

package/dist/core/Store.d.ts

@@ -1,17 +1,29 @@
-import Debug from "../system/Debug";
-import type { PluginSubscriptions, StoreMutationSubscription, StoreMutationSubscriptionCallback, StoreOnActionSubscription, StoreOnActionSubscriptionCallback } from "../types/plugin";
+import Tracer from "../system/Tracer";
+import type { PluginStoreOptions, PluginSubscriptionOptions, PluginSubscriptions, StoreClassConstructorParams, StoreMutationSubscription, StoreMutationSubscriptionCallback, StoreOnActionSubscription, StoreOnActionSubscriptionCallback } from "../types/plugin";
 import type { Store as PiniaStore, StateTree } from "pinia";
-import type { Console } from "../types/log";
+import type { TracePayload } from "../types/trace";
 import type { AnyObject, PluginSubscriberInterface } from "../types";
 import type { StoreOptions, StatePropertyValue } from "../types/store";
-export default class Store extends Debug {
+/**
+ * Base class for a Pinia store with enhanced capabilities.
+ * Provides structured tracing, plugin subscriptions, and state management utilities.
+ * @remarks
+ * This class is intended to be extended by specific store implementations
+ * that require enhanced capabilities such as structured tracing and plugin subscriptions.
+ */
+export default class Store {
     protected _className: string;
+    private _createTracer?;
     private _onAction?;
     private _options;
     private _store;
-    private _subscriptions;
     private _storeSubscribe?;
+    private _subscriptions;
+    private _traceOptions;
+    private _tracer?;
     protected static _requiredKeys?: string[];
+    get classNameAddedToTraceNamespace(): boolean;
+    set classNameAddedToTraceNamespace(value: boolean);
     get onAction(): StoreOnActionSubscription | undefined;
     set onAction(onAction: StoreOnActionSubscriptionCallback);
     get options(): StoreOptions;
@@ -20,34 +32,121 @@ export default class Store extends Debug {
     get store(): AnyObject;
     get storeSubscribe(): StoreMutationSubscription | undefined;
     set storeSubscribe(storeSubscribe: StoreMutationSubscriptionCallback);
-    constructor(store: PiniaStore, options: AnyObject, debug?: boolean, customConsole?: Console);
     /**
-     * Add property to state
-     * @param name
-     * @param value
+     * Returns the structured trace emitter of this store.
+     * Built lazily so that subclasses overriding `_className` are reflected.
+     */
+    protected get tracer(): Tracer | undefined;
+    /**
+     * Constructs a new instance of the store.
+     * @param store The Pinia store instance.
+     * @param options The plugin store options and subscription options.
+     * @remarks
+     * This constructor is typically called by the `customizeStore` static method
+     * to create an instance of the store with the provided Pinia store and options.
+     * @see PluginStoreOptions
+     * @see PluginSubscriptionOptions
+     */
+    constructor(store: PiniaStore, options: StoreClassConstructorParams);
+    /**
+     * Adds a property to the state of this store.
+     * @param name The name of the property to add.
+     * @param value The value of the property to add.
      */
     addToState(name: string, value?: StatePropertyValue): void;
+    /**
+     * Adds a subscription for a specific plugin to this store.
+     * @param pluginName The name of the plugin for which the subscription is being added.
+     * @param subscription The subscription callback or object to add.
+     * @param options Additional options for the subscription, including subscription options and target stores.
+     */
     addSubscription(pluginName: string, subscription: PluginSubscriberInterface, options?: {
         subscriptionOptions?: StoreOptions;
         stores?: PiniaStore[];
     }): void;
+    /**
+     * Called after the store has been hydrated.
+     * @returns A promise that resolves when the post-hydration process is complete, or void if synchronous.
+     */
     afterHydration(): void | Promise<void>;
     /**
      * Create and return a class instance
      * @param store
      * @param options
-     * @param debug
-     * @returns
+     * @template Instance The type of the store instance being created.
+     * @returns The created store instance of type `Instance`, or undefined if the required keys are not present.
+     */
+    static customizeStore<Instance extends Store>(store: PiniaStore, options: PluginStoreOptions & PluginSubscriptionOptions): Instance | undefined;
+    /**
+     * Retrieves the value of a specific store option.
+     * @param optionName The name of the store option to retrieve.
+     * @returns The value of the specified store option, or undefined if not found.
      */
-    static customizeStore<Instance extends Store>(store: PiniaStore, options: AnyObject, debug?: boolean, customConsole?: Console): Instance | undefined;
     getOption(optionName: keyof StoreOptions): import("../types").StoreOptionsPropertyValue;
+    /**
+     * Retrieves the value of a specific state property.
+     * @param propertyName The name of the state property to retrieve.
+     * @returns The value of the specified state property, or undefined if not found.
+     */
     getStatePropertyValue(propertyName: string): any;
+    /**
+     * Retrieves all plugin subscriptions for this store.
+     * @returns An object containing all plugin subscriptions, or undefined if there are none.
+     */
     getSubscriptions(): PluginSubscriptions | undefined;
+    /**
+     * Retrieves the actual value from a potentially reactive reference.
+     * @param value The value to unwrap.
+     * @returns The unwrapped value if it is a reactive reference, otherwise the original value.
+     */
     getValue(value: any): any;
+    /**
+     * Checks if the given property name has a denied first character.
+     * @param property The property name to check.
+     * @returns True if the property name has a denied first character, otherwise false.
+     */
     protected hasDeniedFirstChar(property: string): boolean;
+    /**
+     * Checks if the given options object has all the required keys.
+     * @param options The options object to check.
+     * @returns True if all required keys are present, otherwise false.
+     */
     protected static hasRequiredKeys(options: AnyObject): boolean;
+    /**
+     * Hydrates the store, potentially performing asynchronous operations.
+     * @returns void or a Promise that resolves when hydration is complete.
+     */
     hydrate(): void | Promise<void>;
+    /**
+     * Initializes the tracer for plugin subscriptions if the createTracer option is provided.
+     * @param options The plugin subscription options containing the createTracer function.
+     */
+    private initializeTracer;
+    /**
+     * Checks if the store is using the Options API.
+     * @returns True if the store is using the Options API, otherwise false.
+     */
     isOptionApi(): boolean;
+    /**
+     * Checks if the state object has the specified property.
+     * @param property The property name to check.
+     * @returns True if the state object has the property, otherwise false.
+     */
     stateHas(property: string): boolean;
+    /**
+     * Checks if the store object has the specified property.
+     * @param property The property name to check.
+     * @returns True if the store object has the property, otherwise false.
+     */
     storeHas(property: string): boolean;
+    /**
+     * Emits a structured trace event scoped to this store.
+     * Prefer the factory form for `payload`: it is only resolved when consumed.
+     */
+    trace(label: string, payload?: TracePayload, scope?: string, namespace?: string): void;
+    /**
+     * Emits a structured error event, or rethrows it when no listener matches.
+     */
+    traceError(label: string, error: unknown, payload?: TracePayload, scope?: string, namespace?: string): void;
+    private traceLabelFormatter;
 }

package/dist/factories/console-trace-listener.d.ts

@@ -0,0 +1,7 @@
+import type { Console } from '../types/log';
+import type { TraceListenerGroupBy, ConsoleTraceGroupListener, TraceListener } from '../types/trace';
+/**
+ * Creates an opt-in trace listener that reproduces the former console output.
+ */
+export declare function createConsoleTraceListener(target?: Console): Omit<TraceListener, 'filter'>;
+export declare function createConsoleGroupTraceListener(groupBy?: TraceListenerGroupBy): ConsoleTraceGroupListener;

package/dist/factories/trace-listener.d.ts

@@ -0,0 +1,16 @@
+import type { TraceEventMetadata, TraceFilterFactoryCriterion, TraceFilterFactoryParam, TraceGroupListener, TraceListener } from "../types/trace";
+/**
+ * Creates a trace group listener with optional filtering.
+ * @param filterDef The filter criteria for the trace events.
+ * @param filterMode The mode to apply when evaluating multiple filter criteria: 'every' or 'some'.
+ * @param groupBy The key of the trace event metadata to group by.
+ * @returns A trace listener configured with group handling and filtering.
+ */
+export declare function createTraceGroupListener(filterDef: TraceFilterFactoryCriterion[], filterMode?: 'every' | 'some', groupBy?: keyof TraceEventMetadata): TraceGroupListener;
+/**
+ * Creates a trace listener with optional filtering.
+ * @param param The trace listener parameters including handler and optional filter criteria.
+ * @param filterMode The mode to apply when evaluating multiple filter criteria: 'every' or 'some'.
+ * @returns A trace listener configured with the specified handler and filter.
+ */
+export declare function createTraceListener(listenerDef: TraceFilterFactoryParam | TraceFilterFactoryCriterion[], filterMode?: 'every' | 'some'): TraceListener;

package/dist/factories/trace-registry.d.ts

@@ -0,0 +1,17 @@
+import Tracer from '../system/Tracer';
+import type { AddTraceListenerOptions, TraceEvent, TraceFilterFactoryCriterion, TraceListenerRemover, TraceRegistry, TracerOptions } from '../types/trace';
+/**
+ * Creates a registry for managing trace listeners and creating tracers.
+ * @returns An object containing methods to add and clear trace listeners, and to create tracers.
+ */
+export declare function createTracerRegistry(): TraceRegistry;
+export declare function createTraceGroupsRegistry(): {
+    addListener: (criteria: TraceFilterFactoryCriterion[], { filterMode, groupBy }?: AddTraceListenerOptions) => TraceListenerRemover;
+    clearTraceListeners: () => void;
+    tracerHandler: {
+        closeGroup: (payload: TraceEvent) => void;
+        createTracer: (source: string, options?: TracerOptions) => Tracer;
+        startGroup: (payload: TraceEvent) => void;
+    };
+    hasTraceListeners: () => boolean;
+};

package/dist/helpers/index.d.ts

@@ -2,3 +2,8 @@ export { default as PluginSubscriber } from '../core/PluginSubscriber';
 export { default as Store } from '../core/Store';
 export { CustomConsole } from '../system/log';
 export { isEmpty } from '../utils/validation';
+export type { Console, LogType, StyleDefinition, StyleDefinitionKeys, StyleDefinitions, ConsoleStyleDefinition, ConsoleStyleDefinitionKeys, ConsoleStyleDefinitions } from "../types";
+export type { TraceEvent, TraceEventMetadata, TraceFilter, TraceHandler, TraceLevel, TraceListener, TraceListenerRemover, TracePayload, TraceRegistry, TracerOptions } from "../types/trace";
+export { createTracerRegistry } from "../factories/trace-registry";
+export { default as Tracer } from "../system/Tracer";
+export { createConsoleTraceListener } from "../factories/console-trace-listener";