pinia-plugin-subscription 1.0.0-beta.4 → 1.0.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9
9
 
10
10
  ### Added
11
11
  - Added `createTracerRegistry()` to create isolated trace listeners and tracers for each application or Pinia instance
12
- - Added `createTraceGroupsRegistry()` to group matching trace events in the console
12
+ - Added `createTracerRegistry()` to group matching trace events in the console
13
13
  - Added the `Tracer` class and registry methods `addTraceListener()`, `clearTraceListeners()` and `hasTraceListeners()`
14
14
  - Added metadata-based trace filter criteria with `equals`, `contains`, `startsWith` and `endsWith` comparators, combined with `every` or `some`
15
15
  - Added `createConsoleTraceListener()` as an opt-in console sink for trace events
package/README.md CHANGED
@@ -223,9 +223,9 @@ Events are **not automatically redacted** and may include sensitive action argum
223
223
 
224
224
  ```ts
225
225
  import { createPlugin } from 'pinia-plugin-subscription'
226
- import { createTraceGroupsRegistry } from 'pinia-plugin-subscription/helpers'
226
+ import { createTracerRegistry } from 'pinia-plugin-subscription/helpers'
227
227
 
228
- const traceGroupsRegistry = createTraceGroupsRegistry()
228
+ const traceGroupsRegistry = createTracerRegistry()
229
229
  const remove = traceGroupsRegistry.addListener([
230
230
  { target: 'scope', value: 'cart' },
231
231
  { target: 'namespace', comparator: 'startsWith', value: 'pluginsubscription:subscription:' }
@@ -299,9 +299,9 @@ Normal trace events do not write to a console. To opt into console output groupe
299
299
  by store, configure the registry and pass its `tracerHandler` to the plugin:
300
300
 
301
301
  ```ts
302
- import { createTraceGroupsRegistry } from 'pinia-plugin-subscription/helpers'
302
+ import { createTracerRegistry } from 'pinia-plugin-subscription/helpers'
303
303
 
304
- const traceGroupsRegistry = createTraceGroupsRegistry()
304
+ const traceGroupsRegistry = createTracerRegistry()
305
305
  traceGroupsRegistry.addListener([{ target: 'scope', value: 'cart' }])
306
306
 
307
307
  pinia.use(createPlugin(subscribers, {
@@ -1,22 +1,22 @@
1
1
  var S = Object.defineProperty;
2
- var f = (e, t, r) => t in e ? S(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
3
- var n = (e, t, r) => f(e, typeof t != "symbol" ? t + "" : t, r);
2
+ var f = (e, t, s) => t in e ? S(e, t, { enumerable: !0, configurable: !0, writable: !0, value: s }) : e[t] = s;
3
+ var i = (e, t, s) => f(e, typeof t != "symbol" ? t + "" : t, s);
4
4
  import { isRef as g, ref as b, toRef as l } from "vue";
5
5
  import { defineStore as p } from "pinia";
6
6
  class k {
7
- constructor(t, r) {
8
- n(this, "_createInstance");
9
- n(this, "_name");
10
- n(this, "_pluginOptions");
11
- n(this, "_storeInstance");
12
- n(this, "_resetStoreCallback");
13
- n(this, "_storeOnActionSubscription");
14
- n(this, "_storeMutationSubscription");
15
- n(this, "_subscriptions");
16
- n(this, "pluginCreated");
17
- n(this, "execution");
18
- n(this, "hydrationScheduler");
19
- this._name = t, this._createInstance = r;
7
+ constructor(t, s) {
8
+ i(this, "_createInstance");
9
+ i(this, "_name");
10
+ i(this, "_pluginOptions");
11
+ i(this, "_storeInstance");
12
+ i(this, "_resetStoreCallback");
13
+ i(this, "_storeOnActionSubscription");
14
+ i(this, "_storeMutationSubscription");
15
+ i(this, "_subscriptions");
16
+ i(this, "pluginCreated");
17
+ i(this, "execution");
18
+ i(this, "hydrationScheduler");
19
+ this._name = t, this._createInstance = s;
20
20
  }
21
21
  get name() {
22
22
  return this._name;
@@ -49,11 +49,11 @@ class k {
49
49
  }
50
50
  hydrate(t) {
51
51
  }
52
- invoke({ store: t, options: r }, s) {
52
+ invoke({ store: t, options: s }, r) {
53
53
  return this._storeInstance = this._createInstance(t, {
54
- ...r,
54
+ ...s,
55
55
  ...this.pluginOptions,
56
- createTracer: s ? () => s?.(this.name) : void 0
56
+ createTracer: r ? () => r?.(this.name) : void 0
57
57
  }), this._storeInstance ? (this._subscriptions = this._storeInstance.getSubscriptions(), this._storeMutationSubscription = this._storeInstance.storeSubscribe, this._storeOnActionSubscription = this._storeInstance.onAction, this.pluginCreated && this.pluginCreated(t), !0) : !1;
58
58
  }
59
59
  }
@@ -61,46 +61,46 @@ const u = /* @__PURE__ */ new WeakMap(), a = /* @__PURE__ */ new Map(), h = /* @
61
61
  function O(e, t) {
62
62
  if (h.has(e) || typeof e.$dispose != "function")
63
63
  return;
64
- const r = e.$dispose;
65
- e.$dispose = (...s) => (u.delete(e), a.delete(t), r.apply(e, s)), h.add(e);
64
+ const s = e.$dispose;
65
+ e.$dispose = (...r) => (u.delete(e), a.delete(t), s.apply(e, r)), h.add(e);
66
66
  }
67
- function L(e, t, r) {
68
- const s = r ? { storeOptions: r } : {};
67
+ function L(e, t, s) {
68
+ const r = s ? { storeOptions: s } : {};
69
69
  return typeof t == "function" ? d(
70
70
  e,
71
71
  t,
72
- s
72
+ r
73
73
  ) : y(
74
74
  e,
75
75
  t,
76
- s
76
+ r
77
77
  );
78
78
  }
79
- function q(e, t, r) {
80
- const s = r ? { storeOptions: { ...r, enhancedStore: !0 } } : { storeOptions: { enhancedStore: !0 } };
79
+ function q(e, t, s) {
80
+ const r = s ? { storeOptions: { ...s, enhancedStore: !0 } } : { storeOptions: { enhancedStore: !0 } };
81
81
  return d(
82
82
  e,
83
83
  t,
84
- s
84
+ r
85
85
  );
86
86
  }
87
- function d(e, t, r) {
88
- const s = {
87
+ function d(e, t, s) {
88
+ const r = {
89
89
  id: e,
90
90
  extensions: {}
91
- }, i = r?.storeOptions?.enhancedStore === !0, o = p(
91
+ }, n = s?.storeOptions?.enhancedStore === !0, o = p(
92
92
  e,
93
- () => t(s),
94
- r
93
+ () => t(r),
94
+ s
95
95
  );
96
96
  return Object.assign(((..._) => {
97
- i && a.set(e, s);
97
+ n && a.set(e, r);
98
98
  const c = o(..._);
99
- return i && (u.set(c, s), a.delete(e), O(c, e)), c;
99
+ return n && (u.set(c, r), a.delete(e), O(c, e)), c;
100
100
  }), o);
101
101
  }
102
- function y(e, t, r) {
103
- return r && (t = { ...t, ...r ?? {} }), p(e, t);
102
+ function y(e, t, s) {
103
+ return s && (t = { ...t, ...s ?? {} }), p(e, t);
104
104
  }
105
105
  const A = /* @__PURE__ */ new Set(["_", "$"]);
106
106
  function m(e) {
@@ -116,7 +116,7 @@ function x(e) {
116
116
  throw new Error(`${e.id}Store - getEnhancedStore - Error: enhanced store is required`);
117
117
  return t;
118
118
  }
119
- function T(e, t) {
119
+ function $(e, t) {
120
120
  e.extensions.enhancedStore = t, e.extensions.extending = t;
121
121
  }
122
122
  function F(e) {
@@ -125,25 +125,25 @@ function F(e) {
125
125
  function K(e, t) {
126
126
  return `${e}-${t.$id}`;
127
127
  }
128
- function $(e) {
128
+ function T(e) {
129
129
  return e ? Array.isArray(e) ? e.length === 0 : typeof e == "object" ? Object.keys(e).length === 0 : typeof e == "string" ? e.trim() === "" : !1 : !(typeof e == "boolean" || typeof e == "number");
130
130
  }
131
131
  class I {
132
- constructor(t, r) {
133
- n(this, "_className", "Store");
134
- n(this, "_createTracer");
135
- n(this, "_onAction");
136
- n(this, "_options");
137
- n(this, "_store");
138
- n(this, "_storeSubscribe");
139
- n(this, "_subscriptions", {});
140
- n(this, "_traceOptions", {
132
+ constructor(t, s) {
133
+ i(this, "_className", "Store");
134
+ i(this, "_createTracer");
135
+ i(this, "_onAction");
136
+ i(this, "_options");
137
+ i(this, "_store");
138
+ i(this, "_storeSubscribe");
139
+ i(this, "_subscriptions", {});
140
+ i(this, "_traceOptions", {
141
141
  addClassNameToLabel: !0
142
142
  });
143
- n(this, "_tracer");
144
- if (this._options = r.storeOptions, this._store = t, this.initializeTracer(r), this._options?.enhancedStore) {
145
- const s = C(this.store);
146
- s && T(s, this.store);
143
+ i(this, "_tracer");
144
+ if (this._options = s.storeOptions, this._store = t, this.initializeTracer(s), this.trace("instance:created", t.$id), this._options?.enhancedStore) {
145
+ const r = C(this.store);
146
+ r && ($(r, this.store), this.trace("setup:enhancedStore:success", this.store.$id));
147
147
  }
148
148
  }
149
149
  get classNameAddedToTraceNamespace() {
@@ -187,17 +187,17 @@ class I {
187
187
  get tracer() {
188
188
  return !this._tracer && this._createTracer && (this._tracer = this._createTracer(), this._tracer.scope = this.store.$id), this._tracer;
189
189
  }
190
- addToState(t, r) {
191
- this.isOptionApi() || g(r) || (r = b(r)), this.state[t] = r, this.store[t] = l(this.state, t);
190
+ addToState(t, s) {
191
+ this.isOptionApi() || g(s) || (s = b(s)), this.state[t] = s, this.store[t] = l(this.state, t);
192
192
  }
193
- addSubscription(t, r, s) {
194
- this._subscriptions[t] = { subscription: r, ...s ?? {} };
193
+ addSubscription(t, s, r) {
194
+ this._subscriptions[t] = { subscription: s, ...r ?? {} };
195
195
  }
196
196
  afterHydration() {
197
197
  }
198
- static customizeStore(t, r) {
199
- if (r.storeOptions && this.hasRequiredKeys(r.storeOptions))
200
- return new this(t, r);
198
+ static customizeStore(t, s) {
199
+ if (s.storeOptions && this.hasRequiredKeys(s.storeOptions))
200
+ return new this(t, s);
201
201
  }
202
202
  getOption(t) {
203
203
  return this.options && this.options[t];
@@ -206,7 +206,7 @@ class I {
206
206
  return this.getValue(this.state[t]);
207
207
  }
208
208
  getSubscriptions() {
209
- if (!$(this._subscriptions))
209
+ if (!T(this._subscriptions))
210
210
  return this._subscriptions;
211
211
  }
212
212
  getValue(t) {
@@ -216,7 +216,7 @@ class I {
216
216
  return m(t);
217
217
  }
218
218
  static hasRequiredKeys(t) {
219
- return this._requiredKeys !== void 0 && this._requiredKeys?.every((r) => !!t[r]);
219
+ return this._requiredKeys !== void 0 && this._requiredKeys?.every((s) => !!t[s]);
220
220
  }
221
221
  hydrate() {
222
222
  }
@@ -232,17 +232,17 @@ class I {
232
232
  storeHas(t) {
233
233
  return Object.prototype.hasOwnProperty.call(this.store, t);
234
234
  }
235
- trace(t, r, s, i) {
236
- this.tracer && (t = this.traceLabelFormatter(t), this.tracer.debug(t, i ?? t.toLowerCase(), s, r));
235
+ trace(t, s, r, n) {
236
+ this.tracer && (t = this.traceLabelFormatter(t), this.tracer.debug(t, n ?? t.toLowerCase(), r, s));
237
237
  }
238
- traceError(t, r, s, i, o) {
239
- this.tracer ? (t = this.traceLabelFormatter(t), this.tracer.error(t, o ?? t.toLowerCase(), r, i, s)) : console.error(r);
238
+ traceError(t, s, r, n, o) {
239
+ this.tracer ? (t = this.traceLabelFormatter(t), this.tracer.error(t, o ?? t.toLowerCase(), s, n, r)) : console.error(s);
240
240
  }
241
241
  traceLabelFormatter(t) {
242
- return this.classNameAddedToTraceNamespace && (t = `${this.constructor.name}:${t}`), t;
242
+ return this.classNameAddedToTraceNamespace && (t = `${this._className}:${t}`), t;
243
243
  }
244
244
  }
245
- n(I, "_requiredKeys");
245
+ i(I, "_requiredKeys");
246
246
  const M = "pinia-plugin-subscription";
247
247
  export {
248
248
  k as P,
@@ -254,8 +254,8 @@ export {
254
254
  F as e,
255
255
  K as g,
256
256
  m as h,
257
- $ as i,
257
+ T as i,
258
258
  M as p,
259
- T as s
259
+ $ as s
260
260
  };
261
- //# sourceMappingURL=constantes-2FeJfVVy.js.map
261
+ //# sourceMappingURL=constants-CReRDbPp.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants-CReRDbPp.js","sources":["../../src/core/PluginSubscriber.ts","../../src/utils/store.ts","../../src/utils/validation/index.ts","../../src/core/Store.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: StoreClassConstructorParams) => 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, {\n ...options,\n ...this.pluginOptions,\n createTracer: createTracer ? () => createTracer?.(this.name) : undefined\n }) 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\"\n\nimport type {\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?: () => Tracer\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()\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 as StoreOptions\n this._store = store\n this.initializeTracer(options)\n this.trace('instance:created', store.$id)\n\n if (this._options?.enhancedStore) {\n const ctx = getDefineAStoreSetupContext(this.store)\n\n if (ctx) {\n setEnhancedStore(ctx, this.store)\n this.trace('setup:enhancedStore:success', this.store.$id)\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: StoreClassConstructorParams\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: Omit<PluginSubscriptionOptions, 'createTracer'> & { createTracer?: () => Tracer }) {\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, scope?: string, payload?: TracePayload, 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, scope?: string, payload?: TracePayload, 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._className}:${label}`\n }\n\n return label\n }\n}"],"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","subscription","optionName","propertyName","hasDeniedFirstChar","requiredKey","label","scope","payload","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;AAAA,MAAA,GAAAH;AAAA,MAAA,GAAA,KAAA;AAAA,MAAA,cAAAI,IAAA,MAAAA,IAAA,KAAA,IAAA,IAAA;AAAA,IAAA,CAAA,GAAA,KAAA,kBASA,KAAA,iBAAA,KAAA,eAAA,iBAAA,GAAA,KAAA,6BAAA,KAAA,eAAA,gBAAA,KAAA,6BAAA,KAAA,eAAA,UAAA,KAAA,iBAAA,KAAA,cAAAD,CAAA,GAAA,MAFe;AAAA,EAUR;AACH;AACO,MACHE,IAAQ,oBAAA,QAAA,GACRC,IAAmC,oBAAe,IAAK,GAC1DC,IAAA,oBAAA,QAAA;AAED,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;;AC5FA,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,MAAAC,EAAS;AAAA,ECgFM,YACH/B,GAAKH,GAAA;ADhFpB,IAAAD,EAAA,oBAAY;AACR,IAAAA,EAAA;AACJ,IAAAA,EAAA;AAEA,IAAAA,EAAA;AACI,IAAAA,EAAA;AACJ,IAAAA,EAAA;AAEA,IAAAA,EAAA;AACI,IAAAA,EAAA,uBAAc;AAAA,MAGlB;IACI;AACJ,IAAAA,EAAA;ACwEI,QANgB,KACZ,WAAUC,EAAK,cAAA,KACnB,SAAAG,GACJ,KAAA,iBAAAH,CAAA,GAEA,KAAI,MAAA,oBAAeG,EAAmD,GAAA,GAClE,KAAK,UAAA,eAAkB;AAC3B,YAAAuB,IAAAH,EAAA,KAAA,KAAA;AAAA,MAAAG,MAAAE,EAAAF,GAAA,KAAA,KAAA,GAAA,KAAA,MAAA,+BAAA,KAAA,MAAA,GAAA;AAAA,IAMA;AAAA,EACI;AAAA,ED7ER,IAAA,iCAAA;;ECUA;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,cAAA,GAExC,qBAAwD,KAAA,MAAA,MAEpD,KAAA;AAAA,EAAA;AAAA,EAoBA,WAAKC,GAAQL;AACjB,IAAA,KAAA,YAAA,KAEOM,EAAKN,CAAA,MAChBA,IAAAO,EAAAP,CAAA,IAAA,KAAA,MAAAK,CAAA,IAAAL,GAAA,KAAA,MAAAK,CAAA,IAAAG,EAAA,KAAA,OAAAH,CAAA;AAAA,EAAA;AAAA,EAAA,gBAAAzC,GAAA6C,GAAA1C,GAAA;AAAA,SAAA,eAAAH,CAAA,IAAA,EAAA,cAAA6C,GAAA,GAAA1C,KAAA,CAAA,EAAA;AAAA,EAAA;AAAA,EAYA;EAEI;AAAA,EAEA,OAAK,qBAA0B;AAE/B,QAAIA,EAAK,qBAAU,gBAAeA,EAAA,YAAA;AAC9B,iBAAM,KAAMG,GAAAH,CAAA;AAAA,EAGR;AAAA,EACwD,UAC5D2C,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,CAAAZ,EAAM,KAAA,cAAe;AAEoB,aACzC,KAAA;AAAA,EAAA;AAAA,EAIJ,SAAKC;AACT,WAAAA,GAAA,YAAAA,EAAA,QAAAA;AAAA,EAAA;AAAA,EAAA,mBAAAX,GAAA;AAAA,WAAAuB,EAAAvB,CAAA;AAAA,EAAA;AAAA,EAQA,uBACItB,GACA;AAGA,WAAK,KAAA,kBAAyB,UAAM,KAAA,eAAkB,MAAY,CAAA8C,MAAG,CAAA,CAAA9C,EAAA8C,CAAA,CAAA;AAAA,EACzE;AAAA,EAAA,UAAA;AAAA,EAAA;AAAA,EAOI,iBAAA9C,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,MAAAyB,GAAAC,GAAAC,GAAAC,GAAA;AAAA,IAAA,KAAA,WAAAH,IAAA,KAAA,oBAAAA,CAAA,GAOA,YAAU,MAAgCA,GAAAG,KAAAH,EAAA,YAAA,GAAAE,GAAAD,CAAA;AAAA,EAE1C;AAAA,EAAA,WAAAD,GAAAI,GAAAH,GAAAC,GAAAC,GAAA;AAAA,IAAA,KAAA,UAAAH,IAAA,KAAA,oBAAAA,CAAA,GAAA,KAAA,OAAA,MAAAA,GAAAG,KAAAH,EAAA,YAAA,GAAAI,GAAAF,GAAAD,CAAA,KAQI,QAAO,MAAKG,CAAS;AAAA,EACzB;AAAA,EAAA,oBAAAJ,GAAA;AAAA,WAAA,KAAA,mCAAAA,IAAA,GAAA,KAAA,UAAA,IAAAA,CAAA,KAOQA;AAAA,EACA;AAAA;AD9LRhD,EAjBGmC,GAiBI;ACiMS,MAChBrC,IAAA;"}
@@ -1,7 +1,7 @@
1
- import type { Console } from '../types/log';
2
- import type { TraceListenerGroupBy, ConsoleTraceGroupListener, TraceListener } from '../types/trace';
1
+ import type { TraceListenerGroupBy, ConsoleTraceGroupListener } from '../types/trace';
3
2
  /**
4
- * Creates an opt-in trace listener that reproduces the former console output.
3
+ * Creates a console trace group listener that groups trace events by the specified key.
4
+ * @param groupBy The key of the trace event metadata to group by.
5
+ * @returns A console trace group listener configured to group trace events by the specified key.
5
6
  */
6
- export declare function createConsoleTraceListener(target?: Console): Omit<TraceListener, 'filter'>;
7
7
  export declare function createConsoleGroupTraceListener(groupBy?: TraceListenerGroupBy): ConsoleTraceGroupListener;
@@ -0,0 +1,18 @@
1
+ import type { PluginSubscriber, PluginSubscriberInvoke } from "../types/plugin";
2
+ /**
3
+ * Creates a new plugin subscriber with the given name, invoke function, and optional properties.
4
+ * @param name - plugin name.
5
+ * @param invoke - function to invoke for the plugin subscriber.
6
+ * @param optionalProps - optional additional properties for the plugin subscriber.
7
+ * @param {Function} optionalProps.afterHydration
8
+ * @param {PluginExecutionOptions} optionalProps.execution
9
+ * @param {Function} optionalProps.hydrate
10
+ * @param {PluginHydrationScheduler} optionalProps.hydrationScheduler
11
+ * @param {Function} optionalProps.resetStoreCallback
12
+ * @param {StoreOnActionSubscription} optionalProps.storeOnActionSubscription
13
+ * @param {StoreMutationSubscription} optionalProps.storeMutationSubscription
14
+ * @param {PluginSubscriptions} optionalProps.subscriptions
15
+ * @param
16
+ * @returns A new plugin subscriber object.
17
+ */
18
+ export declare function createPluginSubscriber(name: string, invoke: PluginSubscriberInvoke, optionalProps?: Omit<PluginSubscriber, "name" | "invoke">): PluginSubscriber;
@@ -1,16 +1,10 @@
1
- import type { TraceEventMetadata, TraceFilterFactoryCriterion, TraceFilterFactoryParam, TraceGroupListener, TraceListener } from "../types/trace";
1
+ import type { TraceEventMetadata, TraceFilterFactoryCriterion, TraceFilterFactoryParam, TraceGroupListener } from "../types/trace";
2
2
  /**
3
3
  * Creates a trace group listener with optional filtering.
4
- * @param filterDef The filter criteria for the trace events.
4
+ * @param listenerDef The listener definition or filter criteria for the trace group listener.
5
+ * @param context Print the plugin context (subscribers, store, options, and traces) to the console.. Defaults to true.
5
6
  * @param filterMode The mode to apply when evaluating multiple filter criteria: 'every' or 'some'.
6
7
  * @param groupBy The key of the trace event metadata to group by.
7
8
  * @returns A trace listener configured with group handling and filtering.
8
9
  */
9
- export declare function createTraceGroupListener(filterDef: TraceFilterFactoryCriterion[], filterMode?: 'every' | 'some', groupBy?: keyof TraceEventMetadata): TraceGroupListener;
10
- /**
11
- * Creates a trace listener with optional filtering.
12
- * @param param The trace listener parameters including handler and optional filter criteria.
13
- * @param filterMode The mode to apply when evaluating multiple filter criteria: 'every' or 'some'.
14
- * @returns A trace listener configured with the specified handler and filter.
15
- */
16
- export declare function createTraceListener(listenerDef: TraceFilterFactoryParam | TraceFilterFactoryCriterion[], filterMode?: 'every' | 'some'): TraceListener;
10
+ export declare function createTraceGroupListener(listenerDef: TraceFilterFactoryParam | TraceFilterFactoryCriterion[], context?: boolean, filterMode?: 'every' | 'some', groupBy?: keyof TraceEventMetadata): TraceGroupListener;
@@ -1,12 +1,7 @@
1
1
  import Tracer from '../system/Tracer';
2
- import type { AddTraceListenerOptions, TraceEvent, TraceFilterFactoryCriterion, TraceListenerRemover, TraceRegistry, TracerOptions } from '../types/trace';
3
- /**
4
- * Creates a registry for managing trace listeners and creating tracers.
5
- * @returns An object containing methods to add and clear trace listeners, and to create tracers.
6
- */
7
- export declare function createTracerRegistry(): TraceRegistry;
8
- export declare function createTraceGroupsRegistry(): {
9
- addListener: (criteria: TraceFilterFactoryCriterion[], { filterMode, groupBy }?: AddTraceListenerOptions) => TraceListenerRemover;
2
+ import type { AddTraceListenerOptions, TraceEvent, TraceFilterFactoryCriterion, TraceFilterFactoryParam, TraceListenerRemover, TracerOptions } from '../types/trace';
3
+ export declare function createTracerRegistry(): {
4
+ addListener: (listenerDef: TraceFilterFactoryParam | TraceFilterFactoryCriterion[], { context, filterMode, groupBy }?: AddTraceListenerOptions) => TraceListenerRemover;
10
5
  clearTraceListeners: () => void;
11
6
  tracerHandler: {
12
7
  closeGroup: (payload: TraceEvent) => void;
@@ -4,6 +4,6 @@ export { CustomConsole } from '../system/log';
4
4
  export { isEmpty } from '../utils/validation';
5
5
  export type { Console, LogType, StyleDefinition, StyleDefinitionKeys, StyleDefinitions, ConsoleStyleDefinition, ConsoleStyleDefinitionKeys, ConsoleStyleDefinitions } from "../types";
6
6
  export type { TraceEvent, TraceEventMetadata, TraceFilter, TraceHandler, TraceLevel, TraceListener, TraceListenerRemover, TracePayload, TraceRegistry, TracerOptions } from "../types/trace";
7
- export { createTracerRegistry, createTraceGroupsRegistry } from "../factories/trace-registry";
7
+ export { createTracerRegistry } from "../factories/trace-registry";
8
8
  export { default as Tracer } from "../system/Tracer";
9
- export { createConsoleTraceListener, createConsoleGroupTraceListener } from "../factories/console-trace-listener";
9
+ export { createConsoleGroupTraceListener } from "../factories/console-trace-listener";