Apollo and GraphQL for Vue.js (Options API)

:book: Documentation for Vue 3 | for Vue 2

:pen: Contributing guide

:heart: Sponsor me!

npm i @vue/apollo-option
pnpm i @vue/apollo-option
yarn add @vue/apollo-option

Sponsors

Changelog

v4.2.2

compare changes

🩹 Fixes

• Memory leak in SSR caused by global tracking (#1582)
• Augment vue rather than @vue/runtime-core (#1576)
• UseMutations onError Event hook gets triggered too early (#1585)

📖 Documentation

• Fix $skipAll mention (#1573)

🏡 Chore

• Update deps + jest to vitest (d421887)

✅ Tests

• lint: Switch to eslint 9 and antfu config (99ca23b)

🤖 CI

• Update gh actions to use corepack (f2578cb)
• Update upload artifact (35fb59c)
• Fix cypress (df96345)
• Rename job (d99865f)
• Add name to pr title job (6bfd0ec)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Jeroen De Jong (@thumbnail)
• Mark Florian markrian@gmail.com
• ChatonDeAru (Romain) (@chatondearu)
• Kristaps Fabians Geikins fabis94@live.com

v4.2.1

🩹 Fixes

• Improved pinia support (#1571)

📖 Documentation

• Update broken circleci badge (9622392)
• Readme smaller logo (ff836ea)
• Use nightly.akryum.dev (7f3cf7d)

🏡 Chore

• Specify pnpm version in package.json (732e66e)

❤️ Contributors

• Nick Messing (@nickmessing)
• Guillaume Chau (@Akryum)

v4.2.0

🚀 Enhancements

• Add updateQuery to useQuery (#1552)

🩹 Fixes

• UseMutations onDone Event hook gets triggered too early (#1559)
• (@vue/apollo-option) memory leak in wrapped ssrRender (#1553)
• Reuse previous result, fix #1483 (#1569, #1483)
• ResolveClient throwing too soon, fix #1557 (#1570, #1557)

📖 Documentation

• Add github link to documentation (#1549)
• Note about continuous releases (51e09e7)

🏡 Chore

• Switch some tests to script setup (c8e5106)

🤖 CI

• Nightly releases (319f6ec)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Matt Garrett mattga@gmail.com
• Mobsean (@mobsean)
• Leonardo Santos (@syllomex)
• Alex Liu (@Mini-ghost)

v4.1.0

🩹 Fixes

• Change teardown to use onScopeDispose (#1545)

📖 Documentation

• useQuery: Document refetch with new variables (#1564)

🏡 Chore

• Updqte pnpm to v9 (827ea6e)

✅ Tests

• UseSubscription (0f5ae61)
• Fix subscription test (#1547)

🤖 CI

• Update versions (fe66840)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Nick Messing (@nickmessing)

v4.0.2

🩹 Fixes

• Use shallowRef on result & error (08f0fcd)

📖 Documentation

• Remove mentions of fetchResults, fix #1060 (#1060)

❤️ Contributors

• Guillaume Chau (@Akryum)

v4.0.1

🩹 Fixes

• Use hasInjectionContext in useApolloClient before calling inject (#1529)
• useLazyQuery: Load() on server, fix #1495 (#1495)

✅ Tests

• Split into outsideComponent.cy.ts (48d0ac2)
• Build test app in test command (500d6e4)

🤖 CI

• Use GITHUB_OUTPUT envvar instead of set-output command (#1530)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Arun Sathiya arun@arun.blog
• Dawid Kopys dewke17@gmail.com

v4.0.0

🚀 Enhancements

• useLazyQuery: Add interface for lazy query return (#1523)

🩹 Fixes

• Improve esm support, fix #1524 (#1524)
• Import serializeJs using default import instead of a namespace import (#1485)
• options: Use exponential backoff on subscribe error retry (b17817e)
• ApolloMutation: Return result in mutate (ddf9aa0)
• Prefetch type (f8568e8)

📖 Documentation

• Update vitepress + enable detailed search by default (fb66dce)

🏡 Chore

• Update sheep (9be63fa)

✅ Tests

• Fragment (062f72a)

🤖 CI

• Update node and pnpm (ca3f2f4)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Dawid Kopys dewke17@gmail.com
• Yury Savin yury@savin.dev

v4.0.0-beta.12

🚀 Enhancements

• New context params in event hook handlers (0be5d9b)

🩹 Fixes

• Use shallowRef for apollo query (76f19f6)

📖 Documentation

• Missing curly brace (#1512)
• Added missing createClient import in example when creating Graph… (#1513)
• Import createApolloProvider is missing (#1515)

🏡 Chore

• Moved resolutions to the root of the workspace (#1508)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Hassan hassanfayyaz19@gmail.com
• Mekraldi
• Vitaliy

v4.0.0-beta.11

🩹 Fixes

• Remove console.log, console log remained in code #1507 (#1507)

📖 Documentation

• Update README.md logo (68addf8)
• Update vitepress + fix components API menu (f545763)

❤️ Contributors

• Guillaume Chau (@Akryum)

v4.0.0-beta.10

🚀 Enhancements

• Support effect scope outside of component, fix #1505 (#1505)
• useLazyQuery: Load returns Promise, fix #1486 (#1486)

🩹 Fixes

• Apollo components should have emits (#1504)

🌊 Types

• Extended "enabled" option type (#1492)

🏡 Chore

• Package test-e2e-composable-vue3, update deps, migrate to vite (#1488)
• Upgrade vitepress to 1.0 RC (daffd75)
• Seq test (995131d)

✅ Tests

• lint: Fix (1ac1372)
• Ssr (574bd8f)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Viktor (@websitevirtuoso)
• Vitaliy
• Forgottencsc forgottencosecant@outlook.com

v4.0.0-beta.9

🩹 Fixes

• Don't call debounced restart too much (1adf135)

🏡 Chore

• Update throttle-debounce (500cc49)
• Update deps (f47759e)

❤️ Contributors

• Guillaume Chau (@Akryum)

v4.0.0-beta.8

🚀 Enhancements

• useQuery: Nullable query (auto disable) (28f3520)

❤️ Contributors

• Guillaume Chau (@Akryum)

v4.0.0-beta.7

🩹 Fixes

• ssr: Hydration mismatch with keepPreviousResult (87188c4)

❤️ Contributors

• Guillaume Chau (@Akryum)

v4.0.0-beta.6

🚀 Enhancements

• KeepPreviousResult (e794c1e)

📖 Documentation

• ProvideApolloClient (#1442)

🏡 Chore

• Update graphql to 16 in repo (4dcfa20)
• Typo in test component file (bfca616)
• Update lockfile version (2077502)

✅ Tests

• Update server (13bfbbe)
• Update pnpm version (722fa0f)
• Test-server package (f1ebe70)
• Migrate server to typescript (97c1402)
• Fix (c881439)

❤️ Contributors

• Stefan Schneider stefan.schneider@gmx.net
• Guillaume Chau (@Akryum)

v4.0.0-beta.5

🚀 Enhancements

• UseLazyQuery load returns boolean to make is easier to refetch (dcb1768)
• ts: Update types to account for changes in TypeScript 4.8 (#1454)
• Allow global tracking outside of components (5967e16)

🩹 Fixes

• Don't call variables if query is disabled + fix enabling race conditions, fix #1243, fix #1422 (#1243, #1422)
• Events not registered in case of immediate trigger, fix #1154 (#1154)
• @vue/apollo-composable ESM settings, fix #1462 (#1463, #1462)
• Avoid multiple on error calls without usage of errorPolicy 'all' (#1461)
• Ssr export paths, fix #1469 (#1469)
• Initialize currentDocument early, fix #1325 (#1325)
• ts: Allow null on userLazyQuery load fn, fix #1386 (#1386)
• ssr: Handle result/error set before serverPrefetch call, fix #1429 (#1429)

📖 Documentation

• Subscriptions configuration docs updated to describe graphql-ws configuration. (#1449)

🏡 Chore

• Update lockfile to v6.0 (81ea32c)
• Update sheep/release-tag (cf7917e)

✅ Tests

• Config cypress downloads (32c95de)
• Demo useLazyQuery with immediate load (53554b8)
• Enabled (db7d79c)

🤖 CI

• Switch to github actions (25c31d2)
• Enable on v4 branch (bc3d80c)

❤️ Contributors

• Guillaume Chau (@Akryum)
• Gibran Amparan (@gibranamparan)
• Alessia Bellisario alessia@apollographql.com
• Dominik Klein dk@zammad.com
• Changwan Jun (@wan2land)

4.0.0-beta.4 (2023-02-22)

Features

• improve ESM support (2623b32)

4.0.0-beta.3 (2023-02-21)

Bug Fixes

• ssr: error not bubbling up (18fe206)

4.0.0-beta.2 (2023-02-03)

Bug Fixes

• @vue/apollo-option: ssr cleanup function fails to run (#1424) (#1425) (8dfe93b)
• hydration error, revert #1388, fix #1432 (9302d4d)
• ignore next result only if not loading (1e24d21)
• typo in useResult deprecation message (#1414) (3728928)

4.0.0-beta.1 (2022-10-05)

Bug Fixes

• composable: Remove immediate result logic (#1388) (fc98307)

4.0.0-alpha.20 (2022-07-19)

Reverts

• Revert "fix(options): use beforeUnmount instead of unmounted" (8d51475)

4.0.0-alpha.19 (2022-07-18)

Bug Fixes

• options: use beforeUnmount instead of unmounted (9726e0a)
• Root instance not found when using with Vue 2.7 (#1379) (cb0ab57)
• ssr: mock $apollo after serverPrefetch, fix #1297 (46ea781)

4.0.0-alpha.18 (2022-06-23)

Bug Fixes

• apollo components registered twice, fix #1336 (3ad3ab3)
• change data init, related to #1350 (b94bdf7)
• Make calls of the refetch() & fetchMore() trigger loading state (#1366) (a32fe9c)
• vue-demi updated (#1373) (e959a2c)

4.0.0-alpha.17 (2022-05-03)

Bug Fixes

• $apollo null error if smar obj is destroyed but has throttled/debounced calls (d6d4da1)
• added client options to error policy (#1318) (61261bc)
• avoid onServerPrefetch warning (#1281) (cf89b25)
• remove console.log (a79b790)
• subscriptions array leak (#1248) (f31fa15)
• useQuery loading and debounce issues (#1313) (082acf9), closes #1235 #1271

Features

• allow providing multiple apolloClients outside of setup/vue context in vue-apollo-composable (#1340) (64491ce)
• deprecate useResult (0e9fb48)
• update vue-demi (af9f20f)

4.0.0-alpha.16 (2021-11-28)

Bug Fixes

• destruction of $apollo in vue-apollo-option (#1273) (e2dad14)
• duplicate call to catchError, closes #1133 (eaf1da7)
• improve peerDeps declaration, closes #1263 (3c8545b)
• useMutation outside setup (#1262) (9b3af01)
• useQuery: improve error handling with errorPolicy set to 'all' (04ab9f6)
• useSubscription outside of component (a37a560)

Features

• upgrade dependencies (0595bd3)

4.0.0-alpha.15 (2021-09-20)

Bug Fixes

• apollo-client 3.4 FetchMoreQueryOptions, closes #1252 (e0786ac)
• don't use internal merge strat, closes #1229 (e1026a3)
• remove $isServer, closes #1241 (1180679)
• smart apollo: ensure SmartQuery variables still function when watched expression evaluated (#1161), closes #991 (b67ff78)
• SubscribeToMore: use beforeUnmount (a90840c)
• types: add throttle and debounce options (#1258) (7ffb5f8), closes vuejs#335
• useApolloClient: save current client in closure, closes #1249 (fb18286)
• useQuery: reset error on refetch/fetchMore, closes #1105 (ea123fa)
• useResult: data => data deep required & non-nullable, closes #1250 (4475805)
• vue peerDependencies, closes #1234 (a35b04f)

4.0.0-alpha.14 (2021-07-19)

Bug Fixes

• importing react -_-' (f53bcde)
• mixin: use unmounted instead of destroyed (335d538)
• reference error, when using useQuery (#1218) (08b6b0e)
• target es2018, closes #1220 (e496ba2)

Features

• convert errors into ApolloError (#1225) (334310d)

4.0.0-alpha.13 (2021-07-04)

Bug Fixes

• build (f81f2d4)
• composable: Clear previous error when recieving a result (#1120) (689c284)
• don't track loading outside of vm, closes #1145 (35940d1)
• remove ApolloProvider.provide (40ddcb9)
• useQuery: apply partial result on start (62fa842)

Features

• composable: Type MutateOverrideOptions (4c51cb4)
• options & components API for Vue 3 (8a70c95)

4.0.0-alpha.12 (2020-10-17)

Features

• useLazyQuery, closes #1068 (8e95aea)

4.0.0-alpha.11 (2020-10-17)

Bug Fixes

• clean imports (97be1e2)
• error log: only import graphq printer, closes #994 (5eb9506)
• more updates to apollo-client 3 (fae0229)
• resolveClient use id arg (4a9e959)
• ssr: code broken by eslint fix (f1279d8)
• support Vue 3 vm.root (#1040) (957aae3)
• unresolved promises in ssr (#940) (#1069) (8a71443)
• useApolloClient: add id arg to resolveClient (72d7402)
• useApolloClient: clientId arg not working, closes #1023 (65d1984)
• useEventHook param is not optional (#1027) (1d2f4f3)
• useQuery: use nextTick to support Vue 3 (#1041) (c9ee0ec)

Features

• allow using useQuery outside of setup, closes #1020 (0cd4f95)
• composable: es build (cfbb9da)

4.0.0-alpha.10 (2020-07-27)

4.0.0-alpha.9 (2020-07-27)

Bug Fixes

• Be able to overrid variables in mutate (#946) (1867e73)
• ts: allow undefined for optional variables (#962) (7495987)
• Update @vue/composition-api to v0.6.1 (#1000) (e8e8f54)

4.0.0-alpha.8 (2020-04-02)

Bug Fixes

• ts: Add typings for late variables in useMutation (#925) (576b495)
• ts: mutate() types (5aaa47b)
• ts: useMutation types (a9d9501)

4.0.0-alpha.7 (2020-02-16)

Bug Fixes

• use getCurrentResult() (d64b0c4)

4.0.0-alpha.6 (2020-01-22)

4.0.0-4.0.0-alpha.6.0 (2020-01-22)

Bug Fixes

• compare serialized variables to prevent unnecessary fetch (3a473e2)
• ts: Add full test coverage for TypeScript hook types & fix missing overloads (#895) (32d1f75)
• useMutation: "mutate" optional arguments (9d64fca)
• useMutation: useMutation not taking a Ref (0ad08c7)
• useSbuscription: currentOptions undefined error, closes #903 (fb1565d)

4.0.0-alpha.4 (2019-12-17)

Bug Fixes

• loading tracking not cleanup correctly on component unmount (dbb1c09)
• type: useResult type inferring 'any' (#872) (9edcf2f)
• use onBeforeUnmount (9c4b6b0)

4.0.0-alpha.3 (2019-12-04)

Bug Fixes

• enabled option for useQuery & useSubscription (947ceb1)
• useQuery: throttle & debounce not being applied initially (280301f)

4.0.0-alpha.2 (2019-12-04)

Bug Fixes

• useXXXLoading() oldValue being undefined and triggering watcher (ebea61e)

Features

• useMutation: overrideOptions (3921587)

4.0.0-alpha.1 (2019-12-02)

Bug Fixes

• components: main files (f23d37c)
• deps (f289394)
• enabled (afbb5bd)
• ts error (ab71f87)
• ts: types file name gql.ts to gql.d.ts (#864) (bae6f3c)
• unused import (786dc5b)
• use const (114881d)
• useMutation: allow dyanmic GraphQL document (9a595b4)
• useQuery: do not use finally (1bf9552)
• useQuery: immediate result (b4df941)
• useQuery: isEnabled (e930f0c)
• useQuery: loading status on error (93e6c5b)
• useQuery: resubscribe after error (8fcf54d)
• useQuery: result when error occurs (d7f14b3)
• useSubscription: don't start on server (4c72ff2)
• useSubscription: enabled (52b5188)
• useSubscription: loading status on error (a5dee52)

Features

• @vue/apollo-util pkg + error log utils (f17ae22)
• composition: debounce + throttle (30267b2)
• improved subscribeToMore (6d5ce42)
• useLoading (008e5f3)
• useMutation (c8a7eca)
• useMutation: called ref (bfb5d08)
• useMutation: onDone & onError (74ffbd0)
• useQuery (377f421)
• useQuery: fetchMore (d73eac8)
• useQuery: networkStatus (e57eb7d)
• useQuery: onResult & onError (fac6fea)
• useQuery: prefetch option (151fbd2)
• useQuery: refetch (e77518a)
• useQuery: SSR support (5d3b7dc)
• useSubscription (41b256f)
• useSubscription: onResult, onError (d4b18db)
• wip useLoading (caa9726)