CHANGELOG.md

0.34.0 (2024-04-12)

Bug Fixes

• allow returning of falsy values from useAsync (#670) (f8d9128)
• include .d.mts file for bundler compatibility (#786) (fe769c7)
• remove @nuxt/vue-app peer dependency (#753) (f3b8fbf)
• update link to Bridge documentation (1571863)

0.33.1 (2022-08-01)

Bug Fixes

• lower node engine requirement (3b91919), closes #662

0.33.0 (2022-07-08)

⚠ BREAKING CHANGES

• upgrade defu and other dev-dependencies
• Some of the API and behaviour differ between Vue 2.7 and @vue/composition-api. In addition, there are some composition utilites that are no longer exported from @nuxtjs/composition-api, such as defineAsyncComponent, warn, etc.

Please read https://blog.vuejs.org/posts/vue-2-7-naruto.html for the announcement and more information.

Features

• use vue 2.7 composition api (#645) (ae9307a), closes #644 #643 #593

Miscellaneous Chores

• upgrade defu and other dev-dependencies (1cbce73)

0.32.0 (2022-02-22)

0.31.0 (2021-11-30)

0.30.0 (2021-11-05)

Bug Fixes

• resolve all aliases (#578) (d2c7516)
• use .mjs version of @vue/compoisition-api (#577) (f49884b)

0.29.3 (2021-10-11)

Bug Fixes

• correctly proxify functions within ssrRef (#561) (016ff0a)
• skip setting values that are unchanged in useFetch (#552) (484b061)

0.29.2 (2021-09-21)

Features

• add new exports from @vue/composition-api (6d0ebd0)

0.29.1 (2021-09-21)

0.29.0 (2021-09-08)

0.28.0 (2021-09-04)

Features

• enable script setup syntax (#542) (8bfadeb)

Bug Fixes

• preserve reactive objects on useFetch hydration (#541) (4c3e734)

0.27.0 (2021-08-20)

0.26.0 (2021-07-28)

Bug Fixes

• resolve to single vue instance (#525) (33171bf)

0.25.2 (2021-07-27)

Bug Fixes

• allow setting ssrRef within onGlobalSetup (#523) (320c409)

0.25.1 (2021-07-22)

0.25.0 (2021-07-21)

Bug Fixes

• @vue/composition-api submodule resolution (#517) (bb76b53)

0.24.7 (2021-07-12)

0.24.6 (2021-07-02)

0.24.5 (2021-06-24)

0.24.4 (2021-06-07)

0.24.3 (2021-06-02)

Bug Fixes

• use webpack:config to add entry for better nuxt/storybook compatibility (#495) (1b07abe), closes #494

0.24.2 (2021-05-28)

0.24.1 (2021-05-28)

Bug Fixes

• alias @nuxtjs/composition-api to esm library (5d30325), closes #488

0.24.0 (2021-05-21)

⚠ BREAKING CHANGES

• package exports have been moved

• see #480 for context and further changes to come

• output .mjs files for runtime templates

• (outside of Nuxt) only auto-registers plugin if NODE_ENV == 'test'

Bug Fixes

• add meta plugin after other modules (#481) (86ed34e)
• rework composition API registration (#484) (1e423c3), closes #476 #479

Build System

• move globals and register to runtime directory (842a724)
• output .mjs files for runtime templates (23afd5a)

0.23.4 (2021-04-28)

0.23.3 (2021-04-24)

Bug Fixes

• alias module so we can access process.server in vite node build (#462) (7c997c5)
• correctly generate vite sourcemap (cf4f438)
• export default from register entry (#461) (e491722)

0.23.2 (2021-04-19)

Bug Fixes

• register composition api before middleware (9d4165a), closes #457

0.23.1 (2021-04-14)

Bug Fixes

• use reactive rather than Vue.observable in useFetch (385bb73), closes #455

0.23.0 (2021-04-12)

⚠ BREAKING CHANGES

• @nuxtjs/composition-api/module is now how the module should be imported in nuxt.config

• There is no longer a need to amend moduleNameMapper in your jest.config - you should remove any entry for @nuxtjs/composition-api there. When used outside a Nuxt context, the module will 'auto-mock' and use https://github.com/nuxt-community/composition-api/blob/be94d4f4e1321565864dd3d3d5e850f7cabf6ca9/src/globals.ts instead of live Nuxt configuration.

• @nuxtjs/composition-api/babel has been renamed to @nuxtjs/composition-api/dist/babel-plugin.

• @vue/composition-api is no longer transpiled by default. You should consider adding it to build.transpile, but note that you may also need to add any other libraries that also use @vue/composition-api.

• You should ensure you haven't named any layout '0' as this will conflict with how this package is registering the Vue Composition API.

• defineNuxtConfig, defineNuxtModule and defineNuxtServerMiddleware have been removed. You can create your own helper with the following code:

  import { Module, ServerMiddleware, NuxtConfig } from '@nuxt/types'
  
  export const defineNuxtModule = <T extends Record<string, unknown>>(module: Module<T>) => module
  export const defineNuxtServerMiddleware = (serverMiddleware: ServerMiddleware) => serverMiddleware
  export const defineNuxtConfig = (config: NuxtConfig) => config

Bug Fixes

• register the composition api in a template file (#433) (8cc21ce), closes #415 #391
• return from rather than redirectedFrom from useContext (a159d87), closes #444

Code Refactoring

• change how library is imported (#418) (5bb1a72)
  • fixed an issue with nuxt-vite compatbility
• significant packaging changes (#438) (ddc9c0f)
  • The ESM version of the library is now .mjs (but we polyfill support for this and other .mjs files in webpack 4).
  • This library is now located within node_modules rather than being templated, with a limited template for the config.

0.22.4 (2021-03-23)

Bug Fixes

• prevent resolution errors on old node versions (df3e2fd)

0.22.3 (2021-03-20)

Bug Fixes

• ensure that injected plugin is inserted first (5cd13bc), closes #406

0.22.2 (2021-03-20)

0.22.1 (2021-03-11)

0.22.0 (2021-03-05)

Features

• experimental vite support (#387) (e47805d)

Bug Fixes

• transpile @vue/composition-api (#391) (7e6334f)

0.21.0 (2021-03-03)

Features

• upgrade @vue/composition-api to rc3 (d4faf1d)

Bug Fixes

• build on Windows (#377) (f80ad03)
• use upath in more places for better windows support (#388) (fcd61db)
• use es module import as much as possible (f7269b5), closes #334

0.20.2 (2021-02-18)

Features

• add new exports from composition-api (#380) (9cd5e93)

Bug Fixes

• allow ssrRef in globalSetup (fcf91a7), closes #379

0.20.1 (2021-02-15)

Bug Fixes

• always return $fetch and $fetchState (e0a9cf4), closes #372

0.20.0 (2021-02-14)

⚠ BREAKING CHANGES

• split out types and imports

Features

• add defineNuxtConfig helper (6484e97)
• add useRoute, useRouter and useStore wrapper functions (80e6c08)
• add wrapProperty helper information (bc0e091)
• do some very dodgy things to improve dx (0998d66), closes #334
• fetch improvements (#366) (d4bdbfb), closes #364 nuxt/nuxt.js#8781 #292

Bug Fixes

• correct static-json path with custom router base or cdnURL (fca527e), closes #351
• create static-json folder before dev/build (27e2ffa), closes #337
• ensure defineNuxtConfig is accessible within config file (06500ab)
• split out types and imports (cc81ad6), closes #334
• type issues with new wrapper functions (fb2aa09)
• use es module version of entrypoint in build (72e753a)

0.19.1 (2021-02-04)

Bug Fixes

• set useFetch delay to 0 by default (#362) (33b9790)

0.19.0 (2021-01-25)

Features

• add compositionAPI flag in jsx babel configuration (#304) (fec4218)

Bug Fixes

• don't import core-js polyfill in server build (#353) (2755d6b)
• revert siroc to fix windows error (#356) (acdf18d)

0.18.1 (2021-01-14)

0.18.0 (2021-01-08)

⚠ BREAKING CHANGES

• upgrade @vue/composition-api

Miscellaneous Chores

• upgrade @vue/composition-api (a8fa46d)

0.17.0 (2020-12-12)

Features

• upgrade to vca beta 21 (adds readonly) (9277489)

Bug Fixes

• ensure ssrRef doesn't share state across requests when used in setup() (#310) (61a3b55)

0.16.4 (2020-11-25)

Bug Fixes

• completely disable support for global useMeta if @nuxtjs/pwa detected (5dc5e34)

0.16.3 (2020-11-25)

Features

• respect explicitly set build.corejs version in nuxt.config (b1603cb)

0.16.2 (2020-11-25)

Bug Fixes

• ensure meta plugin is loaded last (c5c7299)

0.16.1 (2020-11-25)

Bug Fixes

• register meta plugin after other plugins (87535eb), closes #307

0.16.0 (2020-11-24)

Features

• allow accessing meta properties in onGlobalSetup (15cf20e), closes #305

Bug Fixes

• docs: update lockfile (952259b)

0.15.1 (2020-11-17)

0.15.0 (2020-11-09)

Features

• add new export from upstream (del) (4845254)

Bug Fixes

• address TS bug (e87d610)
• use globalNuxt in full static mode (1479665)

0.14.0 (2020-11-02)

Features

• add new export from upstream (del) (4845254)

0.13.5 (2020-10-17)

0.13.4 (2020-10-16)

Features

• add reqRef and ssrReqRef for refs to be reset per-request (b6f327c)

0.13.3 (2020-10-15)

Bug Fixes

• fallback to instance for nuxt context (d40c07b), closes #264

0.13.2 (2020-10-15)

Bug Fixes

• reinitialise global setup callbacks on each request (7816afe), closes #270

0.13.1 (2020-10-14)

Bug Fixes

• prevent useMeta from sharing state in ssr (#268) (e54cefe)

0.13.0 (2020-10-12)

Features

• allow computed properties within useMeta (#255) (7152ed4)

Bug Fixes

• use siroc to build (79106c2), closes #259

0.12.6 (2020-10-10)

0.12.5 (2020-09-18)

0.12.4 (2020-09-16)

Bug Fixes

• remove markReactive export (#239) (d455d0f), closes #238

0.12.3 (2020-08-26)

Bug Fixes

• load nuxt edge utils if available (#219) (563bb3c)
• overwrite titleTemplate with undefined (#220) (dc6f253)

0.12.2 (2020-08-18)

Bug Fixes

• use Promise.resolve() to cover all possible promise cases (#211) (6d10312), closes #210

0.12.1 (2020-08-16)

0.12.0 (2020-08-09)

Features

• add new exports from @vue/composition-api (5bbcfd7)

0.11.0 (2020-07-27)

Features

• add nuxt helpers (#160) (8a9885e)

0.10.6 (2020-07-14)

Bug Fixes

• add support for windows (#140) (c39773f)
• correctly check for isFullStatic (db87441)

0.10.5 (2020-07-09)

Bug Fixes

• create static-json dir at correct point in generate lifecycle (2d4e10b)
• test for nuxt instance before loading static (43d5ee6), closes #143

0.10.4 (2020-07-09)

Bug Fixes

• revert to custom ssr fetch handling (6cde3df), closes #133 #141 #143

0.10.3 (2020-07-01)

Bug Fixes

• check static path exists before copying files (9f1bdc7)

0.10.2 (2020-06-25)

Bug Fixes

• remove console.log (0b1d5a8)

0.10.1 (2020-06-25)

Features

• export nextTick from @vue/composition-api (df68e0a)

0.10.0 (2020-06-25)

⚠ BREAKING CHANGES

• requires nuxt 2.13+ for useFetch

Features

• support static target for useFetch (74205b5), closes #127

Bug Fixes

• handle preexisting babel plugins function (c5c338f)
• specify type for inline function (694f21b)
• write static files synchronously (eb91a5f)

0.9.3 (2020-06-13)

Features

• add ssrPromise functionality (461939d), closes #115

0.9.2 (2020-06-13)

Features

• provide access to global setup() function (7fd70d9), closes #104 #111

Bug Fixes

• remove duplicate static path definition (48b9afb)

Performance Improvements

• remove unnecessary spread (2300a93)

0.9.1 (2020-06-11)

0.9.0 (2020-06-10)

⚠ BREAKING CHANGES

• There are a number of breaking changes in the latest upstream composition-api. See https://github.com/vuejs/composition-api/releases/tag/v0.6.0 for details.

Features

• upgrade to @vue/composition-api v0.6.1 (3d0bdc6)

0.8.2 (2020-06-04)

Bug Fixes

• regression if ssrRef is used outside setup (in dev) (f2beecd)

0.8.1 (2020-06-02)

Bug Fixes

• re-run ssrRef factory functions on hot module reload (282b8d2), closes #88

0.8.0 (2020-05-30)

Features

• add useStatic helper to inline results of API calls (#79) (460b615)

0.7.5 (2020-05-30)

Bug Fixes

• allow extension of useContext return type (24d7586), closes #84

0.7.4 (2020-05-28)

Bug Fixes

• transpile buildModule (2d5388d), closes #80

0.7.3 (2020-05-27)

Bug Fixes

• useMeta refs should be reactive (#81) (74cb5ef)

0.7.2 (2020-05-27)

Bug Fixes

• allow custom globalContext and globalNuxt (#80) (8b8d7eb)
• reduce chance of $fetch/$fetchState collision (534dc43), closes #74
• sanitise ssrRefs (fcb4a9d)

0.7.1 (2020-05-19)

Bug Fixes

• register composition api before layouts (93024a8), closes #64 #65

0.7.0 (2020-05-14)

⚠ BREAKING CHANGES

• route, query, from and params are now returned as refs from useContext, which was probably what you wanted anyway.

Bug Fixes

• make route-related context reactive (91292c8)

0.6.3 (2020-05-11)

Features

• create shallowSsrRef (#49) (5ef0f6c)

0.6.2 (2020-05-11)

Features

• use appropriate core-js polyfill for ie11 (5281e66)

Bug Fixes

• insert composition api plugin before others (2ef608b)
• reduce meta type definitions (fa9efa3)
• revert data sanitisation (1a4bbed)
• sanitise ssrRef data (d86fdb2)

0.6.1 (2020-05-10)

Features

• allow ssrRef to work outside of setup (#46) (6a67c05)

Bug Fixes

• improve default values for useMeta (f3024e1)

0.6.0 (2020-05-09)

⚠ BREAKING CHANGES

• useHead() no longer exists and instead useMeta can be used directly within setup, as long as a minimal head: {} is defined in the component options.

Note: Work has already begun on composable hooks for vue-meta that will mean we don't need to define a minimal head object: see here.

Features

• allow automatic injection of head() into components (#43) (f1bda39), closes #41
• return $fetch and $fetchState from useFetch (c45177f)

0.5.0 (2020-05-08)

Features

• add useAsync and improve ssrRef (#28) (31c9729)

Bug Fixes

• address cross-request state pollution (b7248c7)
• remove no-setup ssrRefs until solution (707fb25)

Performance Improvements

• improve memory usage (e3f7221)

0.4.1 (2020-05-08)

Bug Fixes

• hotfix so ssrRefs work in production (7c15c92), closes #28

0.4.0 (2020-05-08)

⚠ BREAKING CHANGES

• withContext is now deprecated

Features

• add useContext helper function (9752a61), closes #29
• add composition api helper to interact with head() (#35) (b7467e2)

Bug Fixes

• correctly type ssrRef with factory function (7b734ac)
• make useContext API available (#39) (dc4f028)

0.3.2 (2020-05-04)

Bug Fixes

• purge non-stringifiable values from ssrRefs (ac199b1)

0.3.1 (2020-05-04)

Bug Fixes

• set ssrContext through plugin (3ba85f5)
• use own onServerPrefetch for useFetch (60e23dd)

0.3.0 (2020-05-04)

Features

• add ssrRef capability for automatic SSR support (#23) (f27fae8)

Reverts

• Revert "docs: remove live demo link (Now is rate-limiting deploy)" (bbd8661)

0.2.3 (2020-05-01)

Bug Fixes

• respect fetchOnServer option (368f33d)

0.2.2 (2020-04-30)

Bug Fixes

• correctly match $fetch and $fetchState features (e2d0442)

0.2.1 (2020-04-30)

Bug Fixes

• require @vue/composition-api (f81182e)

0.2.0 (2020-04-30)

Features

• enable this to be used as a nuxt module (#13) (9c5dee7)

0.1.5 (2020-04-29)

Bug Fixes

• disable browser build (849edee)

0.1.4 (2020-04-29)

0.1.3 (2020-04-28)

Bug Fixes

• set $fetchState if nonexistent (d94c40e)

0.1.2 (2020-04-27)

⚠ BREAKING CHANGES

• onFetch can now be accessed using useFetch

Code Refactoring

• rename onFetch to useFetch (3647769)

0.1.1 (2020-04-27)

Features

• add withContext hook (179f0e1)