@pinia/colada-plugin-delay 0.1.2 → 0.1.3

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import * as vue5 from "vue";
+import * as vue0 from "vue";
 import { ComponentInternalInstance, ComputedRef, EffectScope, MaybeRefOrGetter, Plugin, ShallowRef } from "vue";
 import * as pinia0 from "pinia";
 import { Pinia } from "pinia";
@@ -267,6 +267,33 @@ interface UseQueryOptions<TData = unknown, TError = ErrorDefault, TDataInitial e
    * @see {@link placeholderData}
    */
   initialData?: () => TDataInitial;
+  /**
+   * The timestamp (in milliseconds) when the initial data was last updated.
+   * This determines the staleness of the {@link initialData}. If not provided,
+   * defaults to `Date.now()` when initial data is set.
+   *
+   * @default Date.now() when {@link initialData} is used
+   *
+   * @example
+   * ```ts
+   * // Using a static timestamp
+   * useQuery({
+   *   key: ['user'],
+   *   query: () => fetchUser(),
+   *   initialData: () => cachedUser,
+   *   initialDataUpdatedAt: 1234567890000
+   * })
+   *
+   * // Using a function
+   * useQuery({
+   *   key: ['user'],
+   *   query: () => fetchUser(),
+   *   initialData: () => cachedUser,
+   *   initialDataUpdatedAt: () => Number(localStorage.getItem('userTimestamp'))
+   * })
+   * ```
+   */
+  initialDataUpdatedAt?: number | (() => number);
   /**
    * A placeholder data that is initially shown while the query is loading for
    * the first time. This will also show the `status` as `success` until the
@@ -487,7 +514,8 @@ interface UseQueryEntry<TData = unknown, TError = unknown, TDataInitial extends
    */
   meta: QueryMeta;
   /**
-   * Extensions to the query entry added by plugins.
+   * Extensions to the query entry added by plugins. Must be extended in the
+   * `extend` action.
    */
   ext: UseQueryEntryExtensions<TData, TError, TDataInitial>;
   /**
@@ -528,7 +556,7 @@ declare const useQueryCache: pinia0.StoreDefinition<"_pc_query", Pick<{
    * Scope to track effects and components that use the query cache.
    * @internal
    */
-  _s: vue5.Raw<EffectScope>;
+  _s: vue0.Raw<EffectScope>;
   setQueryData: <TData = unknown, TError = {
     custom: Error;
   }, TDataInitial extends TData | undefined = undefined>(key: EntryKeyTagged<TData, TError, TDataInitial> | EntryKey, data: NoInfer<TData> | Exclude<NoInfer<TDataInitial>, undefined> | ((oldData: TData | TDataInitial | undefined) => TData | Exclude<TDataInitial, undefined>)) => void;
@@ -564,7 +592,7 @@ declare const useQueryCache: pinia0.StoreDefinition<"_pc_query", Pick<{
    * Scope to track effects and components that use the query cache.
    * @internal
    */
-  _s: vue5.Raw<EffectScope>;
+  _s: vue0.Raw<EffectScope>;
   setQueryData: <TData = unknown, TError = {
     custom: Error;
   }, TDataInitial extends TData | undefined = undefined>(key: EntryKeyTagged<TData, TError, TDataInitial> | EntryKey, data: NoInfer<TData> | Exclude<NoInfer<TDataInitial>, undefined> | ((oldData: TData | TDataInitial | undefined) => TData | Exclude<TDataInitial, undefined>)) => void;
@@ -600,7 +628,7 @@ declare const useQueryCache: pinia0.StoreDefinition<"_pc_query", Pick<{
    * Scope to track effects and components that use the query cache.
    * @internal
    */
-  _s: vue5.Raw<EffectScope>;
+  _s: vue0.Raw<EffectScope>;
   setQueryData: <TData = unknown, TError = {
     custom: Error;
   }, TDataInitial extends TData | undefined = undefined>(key: EntryKeyTagged<TData, TError, TDataInitial> | EntryKey, data: NoInfer<TData> | Exclude<NoInfer<TDataInitial>, undefined> | ((oldData: TData | TDataInitial | undefined) => TData | Exclude<TDataInitial, undefined>)) => void;
@@ -1352,7 +1380,7 @@ type UseMutationEntryFilter = EntryFilter<UseMutationEntry>;
  * composable, or in injectable contexts like stores and navigation guards.
  */
 declare const useMutationCache: pinia0.StoreDefinition<"_pc_mutation", Pick<{
-  caches: vue5.Ref<Map<number, UseMutationEntry<unknown, any, unknown, any>>, Map<number, UseMutationEntry<unknown, any, unknown, any>>>;
+  caches: vue0.Ref<Map<number, UseMutationEntry<unknown, any, unknown, any>>, Map<number, UseMutationEntry<unknown, any, unknown, any>>>;
   create: <TData = unknown, TVars = unknown, TError = unknown, TContext extends Record<any, any> = _EmptyObject>(options: UseMutationOptionsWithDefaults<TData, TVars, TError, TContext>, key?: EntryKey | undefined, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>;
   ensure: <TData = unknown, TVars = unknown, TError = unknown, TContext extends Record<any, any> = _EmptyObject>(entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>;
   ensureDefinedMutation: <T>(fn: () => T) => unknown;
@@ -1367,9 +1395,9 @@ declare const useMutationCache: pinia0.StoreDefinition<"_pc_mutation", Pick<{
    * Scope to track effects and components that use the mutation cache.
    * @internal
    */
-  _s: vue5.EffectScope;
+  _s: vue0.EffectScope;
 }, "caches" | "_s">, Pick<{
-  caches: vue5.Ref<Map<number, UseMutationEntry<unknown, any, unknown, any>>, Map<number, UseMutationEntry<unknown, any, unknown, any>>>;
+  caches: vue0.Ref<Map<number, UseMutationEntry<unknown, any, unknown, any>>, Map<number, UseMutationEntry<unknown, any, unknown, any>>>;
   create: <TData = unknown, TVars = unknown, TError = unknown, TContext extends Record<any, any> = _EmptyObject>(options: UseMutationOptionsWithDefaults<TData, TVars, TError, TContext>, key?: EntryKey | undefined, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>;
   ensure: <TData = unknown, TVars = unknown, TError = unknown, TContext extends Record<any, any> = _EmptyObject>(entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>;
   ensureDefinedMutation: <T>(fn: () => T) => unknown;
@@ -1384,9 +1412,9 @@ declare const useMutationCache: pinia0.StoreDefinition<"_pc_mutation", Pick<{
    * Scope to track effects and components that use the mutation cache.
    * @internal
    */
-  _s: vue5.EffectScope;
+  _s: vue0.EffectScope;
 }, never>, Pick<{
-  caches: vue5.Ref<Map<number, UseMutationEntry<unknown, any, unknown, any>>, Map<number, UseMutationEntry<unknown, any, unknown, any>>>;
+  caches: vue0.Ref<Map<number, UseMutationEntry<unknown, any, unknown, any>>, Map<number, UseMutationEntry<unknown, any, unknown, any>>>;
   create: <TData = unknown, TVars = unknown, TError = unknown, TContext extends Record<any, any> = _EmptyObject>(options: UseMutationOptionsWithDefaults<TData, TVars, TError, TContext>, key?: EntryKey | undefined, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>;
   ensure: <TData = unknown, TVars = unknown, TError = unknown, TContext extends Record<any, any> = _EmptyObject>(entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>;
   ensureDefinedMutation: <T>(fn: () => T) => unknown;
@@ -1401,7 +1429,7 @@ declare const useMutationCache: pinia0.StoreDefinition<"_pc_mutation", Pick<{
    * Scope to track effects and components that use the mutation cache.
    * @internal
    */
-  _s: vue5.EffectScope;
+  _s: vue0.EffectScope;
 }, "get" | "create" | "ensure" | "ensureDefinedMutation" | "mutate" | "remove" | "extend" | "setEntryState" | "getEntries" | "untrack">>;
 /**
  * The cache of the mutations. It's the store returned by {@link useMutationCache}.

package/dist/index.d.mts

@@ -267,6 +267,33 @@ interface UseQueryOptions<TData = unknown, TError = ErrorDefault, TDataInitial e
    * @see {@link placeholderData}
    */
   initialData?: () => TDataInitial;
+  /**
+   * The timestamp (in milliseconds) when the initial data was last updated.
+   * This determines the staleness of the {@link initialData}. If not provided,
+   * defaults to `Date.now()` when initial data is set.
+   *
+   * @default Date.now() when {@link initialData} is used
+   *
+   * @example
+   * ```ts
+   * // Using a static timestamp
+   * useQuery({
+   *   key: ['user'],
+   *   query: () => fetchUser(),
+   *   initialData: () => cachedUser,
+   *   initialDataUpdatedAt: 1234567890000
+   * })
+   *
+   * // Using a function
+   * useQuery({
+   *   key: ['user'],
+   *   query: () => fetchUser(),
+   *   initialData: () => cachedUser,
+   *   initialDataUpdatedAt: () => Number(localStorage.getItem('userTimestamp'))
+   * })
+   * ```
+   */
+  initialDataUpdatedAt?: number | (() => number);
   /**
    * A placeholder data that is initially shown while the query is loading for
    * the first time. This will also show the `status` as `success` until the
@@ -487,7 +514,8 @@ interface UseQueryEntry<TData = unknown, TError = unknown, TDataInitial extends
    */
   meta: QueryMeta;
   /**
-   * Extensions to the query entry added by plugins.
+   * Extensions to the query entry added by plugins. Must be extended in the
+   * `extend` action.
    */
   ext: UseQueryEntryExtensions<TData, TError, TDataInitial>;
   /**

package/dist/index.mjs

@@ -41,7 +41,7 @@ function* find$1(map, partialKey) {
 *
 * @internal
 */
-const START_EXT = {};
+const START_EXT = Object.freeze({});
 
 //#endregion
 //#region ../../src/define-query-options.ts
@@ -194,7 +194,7 @@ const useQueryCache = /* @__PURE__ */ defineStore(QUERY_STORE_ID, ({ action }) =
 	* @param [options] - options attached to the query
 	* @param [initialData] - initial data of the query if any
 	* @param [error] - initial error of the query if any
-	* @param [when] - relative when was the data or error fetched (will be added to Date.now())
+	* @param [when] - relative when was the data or error fetched (will be substracted to Date.now())
 	* @param [meta] - resolved meta information for the query
 	*/
 	const create$1 = action((key, options = null, initialData, error = null, when = 0, meta = {}) => scope.run(() => {
@@ -351,7 +351,8 @@ const useQueryCache = /* @__PURE__ */ defineStore(QUERY_STORE_ID, ({ action }) =
 		if (previousEntry && keyHash === previousEntry.keyHash) return previousEntry;
 		let entry = cachesRaw.get(keyHash);
 		if (!entry) {
-			cachesRaw.set(keyHash, entry = create$1(key, options, options.initialData?.(), null, 0, toValue(options.meta)));
+			const initialDataUpdatedAt = toValue(options.initialDataUpdatedAt);
+			cachesRaw.set(keyHash, entry = create$1(key, options, options.initialData?.(), null, initialDataUpdatedAt != null ? Date.now() - initialDataUpdatedAt : 0, toValue(options.meta)));
 			if (options.placeholderData && entry.state.value.status === "pending") entry.placeholderData = toValueWithArgs(options.placeholderData, isEntryUsingPlaceholderData(previousEntry) ? previousEntry.placeholderData : previousEntry?.state.value.data);
 			triggerRef(caches);
 		}