@pinia/colada - npm Package Versions

0.12.1 (2024-11-09)

Bug Fixes

• staleTime of Infinity should still be stale (#99) (6873a6f)

0.12.0 (2024-11-06)

⚠ BREAKING CHANGES

• transformError was never fully implemented so they are being removed and might come back if they is a real-word use case for them
• If you were using the delayLoadingRef util, use the @pinia/colada-plugin-delay instead.
• Renaming Error to defaultError allows to differentiate the property from the existing global Error class. Upgrading should be straightforward.

Features

• add initial delay plugin (42c8760)
• add track and untrack actions for plugins (8902ba3)
• allow dynamic values for auto refetches (63d2fd0)
• allow extending useQuery return (ef06628)
• expose more types (4447d6d)
• plugins: pass scope for added variables (a3b666f)
• work without the plugin (696f88e)

Bug Fixes

• avoid broken reactivity in defineQuery (4c48abc)
• dedupe pinia colada (6ace8e8)
• keep data if signal is aborted (de5cde5)
• pass onMutate context (618312b), closes #95
• remove queryCache from mutation hooks (3f1119a)
• run create in ssr too (1a6fa4a)
• ssr: throw on error in query (58b7f69)
• upgrade to new cache format (03e1683)

Code Refactoring

• query: remove unused transformError and setup options (de0cb48)
• remove delayLoadingRef helper in favor of the plugins (4c9b4cb)
• rename the global Error property in TypesConfig to (0021426)

0.11.1 (2024-10-28)

Features

• allow refetches to throw on erorr (f168b6c)
• allow setting data for unexisting queries (5c3870c)

Bug Fixes

• allow gcTime to never be set (4714b9a)
• eagerly change asyncStatus on cancel (b2f1349)
• staleTime of 0 always refreshes (66ef9ec)

0.11.0 (2024-10-25)

⚠ BREAKING CHANGES

• mutations: This wasn't needed as instead, one can use useQueryCache() outside. It could be added back if needed but it's more pragmatic to start without it.
• query: The queryCache.cancelQuery() is renamed to queryCache.cancel() to better match the other functions naming. A new function queryCache.cancelQueries() is added to actually cancel one or multiple queries instead of just one.
• plugins: In plugins, cache is renamed to queryCache for consistency.
• This makes it clearer that queryCache is the result of useQueryCache().

Features

• add mutation store (#47) (7954f83)
• hmr: warn against bugs (7bb44a0)
• nuxt: add auto imports (964bce2)
• nuxt: support colada.options (57a0430)
• predicate in filter (2fc62b7)
• query: add cancelQueries (a374ee2)
• run defined mutations in effect scope (86ff5ed)

Bug Fixes

• nuxt: plugins (fd95add)

Performance Improvements

• tree shake unused stores (e0ede7e)

Code Refactoring

• mutations: Remove queryCache from the context (d9c2509)
• plugins: rename cache to queryCache (c97639b)
• rename caches to queryCache (e514d33)

0.10.0 (2024-10-04)

⚠ BREAKING CHANGES

• useMutation() hooks now uses positional arguments. This change is mainly to simplify migration from TanStack Query.
• caches.invalidateQueries() only fetches active queries
• The keys option that automatically invalidate keys has been renamed to invalidateKeys and moved to a plugin. This is in practice not needed. It's just an opinionated convenience that can be replaced by directly invalidating queries in the cache with the onSettled() hook in useMutation():

const { mutate } = useMutation({
  onSettled({ caches, vars: { id } }) {
    caches.invalidateQueries({ key: ['contacts-search'] })
    caches.invalidateQueries({ key: ['contacts', id] })
  },
  mutation: (contact) => patchContact(contact),
})

Features

• caches.invalidateQueries only fetches active queries (e8d9088)

• rename keys to invalidateKeys and move to plugin (f709928)

• useMutation hooks now use positional arguments (dce00b4)

0.9.1 (2024-09-27)

Features

• allow nullish return in placeholderData (1fae179)
• wip nuxt module (66eca6e)
• wip placeholderData (307e366)

Bug Fixes

• query: handle sync errors (cfcdcb1), closes #70 #69

0.9.0 (2024-08-26)

⚠ BREAKING CHANGES

• query-cache: To better match the arguments, the setQueryState action has been renamed to setEntryState.

Features

• mutations: add variables (2e03a93)
• query-cache: Rename setQueryState to setEntryState (f481eb0)
• warn: warn about reused keys (7375a19)

0.8.2 (2024-08-21)

Performance Improvements

• skip reactivity traversal in store (3984a3a)

0.8.1 (2024-08-17)

Features

• ssr: expose reviveTreeMap (32b4f17)

Bug Fixes

• ssr: mark raw tree node in reviver (4ff13ad)

0.8.0 (2024-08-12)

⚠ BREAKING CHANGES

• isFetching from useQuery() is renamed to isLoading to better reflect that it's connected to asyncStatus.

• The setup option in useQuery now receives the options as the second argument instead of a context object with the query return value and the options. This allows the setup function to have a more predictable signature and makes it easier to type. Only PiniaColada has this option, it has been removed from useQuery. Overall, the option still needs more thinking and will probably change in the future again.

• plugins: The onSuccess, onError, and onSettled global hooks have been moved from PiniaPlugin to a Pinia Colada plugin: PiniaColadaQueryHooksPlugin

   app.use(PiniaColada, {
  +  plugins: [
  +    PiniaColadaQueryHooksPlugin({
         onSuccess() {},
         onError() {},
         onSettled() {},
  +    }),
  +  ],
   })
  

• This feature splits up the status state into two different status properties:

• status is now just for the data 'pending' | 'success' | 'error'
• queryStatus tells if the query is still running or not with 'idle' | 'running'

• refetch, refresh and similar methods now resolve the state property without rejecting. This is usually more convenient.
• The QueryStatus type has been split into DataStateStatus and OperationStateStatus.
• the cache store is going through a refactor to empower plugins. This change shouldn't affect end users unless you are directly using the cache store. As a result a lot of the actions have been renamed

• refetch -> fetch
• invalidateEntry -> invalidate
• ensureEntry -> ensure

Their arguments have changed as well.

• This release removes the deprecated QueryPlugin. Use PiniaColada instead.

Features

• add a state property to useQuery for type narrowing (22f3e21)
• mutation: refetch active queries (#65) (3ebc734)
• plugins: Refactor query global hooks into a plugin (bbe5199)
• query: add active property to query entry (994db63), closes #65
• split useMutation status like useQuery (6c6078f)

Code Refactoring

• rename isFetching to isLoading (003f7a1)
• rename cache store actions (792ec6e)
• Replace QueryPlugin with PiniaColada (2a3f3d9)
• useQuery setup option now receives the options as the second argument (a86b41d)