Skip to content

Commit

Permalink
Merge branch 'main' into pr/cleanup-check-js
Browse files Browse the repository at this point in the history
  • Loading branch information
jerelmiller authored Jan 29, 2025
2 parents 331a261 + 86f23a4 commit d8f2b5c
Show file tree
Hide file tree
Showing 13 changed files with 226 additions and 163 deletions.
5 changes: 0 additions & 5 deletions .changeset/lemon-singers-pay.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/ten-rules-stare.md

This file was deleted.

8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# @apollo/client

## 3.12.8

### Patch Changes

- [#12292](https://github.com/apollographql/apollo-client/pull/12292) [`3abd944`](https://github.com/apollographql/apollo-client/commit/3abd944e4adde5d94d91133f2bf6ed1c7744f8c5) Thanks [@phryneas](https://github.com/phryneas)! - Remove unused dependency `response-iterator`

- [#12287](https://github.com/apollographql/apollo-client/pull/12287) [`bf313a3`](https://github.com/apollographql/apollo-client/commit/bf313a39d342a73dc3e9b3db9415c71c2573db3f) Thanks [@phryneas](https://github.com/phryneas)! - Fixes an issue where `client.watchFragment`/`useFragment` with `@includes` crashes when a separate cache update writes to the conditionally included fields.

## 3.12.7

### Patch Changes
Expand Down
177 changes: 177 additions & 0 deletions docs/source/_sidebar.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
switcher:
heading: "Apollo Client (Web)"
versions:
- label: v3
latest: true
href: ./
- label: v2
href: ./v2
items:
- label: Introduction
href: "."
- label: Why Apollo Client?
href: ./why-apollo
- label: Get started
href: ./get-started
- label: Changelog
href: https://github.com/apollographql/apollo-client/blob/main/CHANGELOG.md
- label: Fetching
children:
- label: Queries
href: ./data/queries
- label: Suspense
href: ./data/suspense
- label: Fragments
href: ./data/fragments
- label: Mutations
href: ./data/mutations
- label: Refetching
href: ./data/refetching
- label: Subscriptions
href: ./data/subscriptions
- label: Directives
href: ./data/directives
- label: Error handling
href: ./data/error-handling
- label: Document transforms
href: ./data/document-transforms
- label: Best practices
href: ./data/operation-best-practices
- label: Caching
children:
- label: Overview
href: ./caching/overview
- label: Configuration
href: ./caching/cache-configuration
- label: Reading and writing
href: ./caching/cache-interaction
- label: Garbage collection and eviction
href: ./caching/garbage-collection
- label: Customizing field behavior
href: ./caching/cache-field-behavior
- label: Memory Management
href: ./caching/memory-management
- label: Advanced topics
href: ./caching/advanced-topics
- label: Pagination
children:
- label: Overview
href: ./pagination/overview
- label: Core API
href: ./pagination/core-api
- label: Offset-based
href: ./pagination/offset-based
- label: Cursor-based
href: ./pagination/cursor-based
- label: keyArgs
href: ./pagination/key-args
- label: Local State
children:
- label: Overview
href: ./local-state/local-state-management
- label: Local-only fields
href: ./local-state/managing-state-with-field-policies
- label: Reactive variables
href: ./local-state/reactive-variables
- label: Client-side schema
href: ./local-state/client-side-schema
- label: Local resolvers
href: ./local-state/local-resolvers
- label: Development & Testing
children:
- label: Developer tools
href: ./development-testing/developer-tooling
- label: Using TypeScript
href: ./development-testing/static-typing
- label: Testing React components
href: ./development-testing/testing
- label: Schema-driven testing
href: ./development-testing/schema-driven-testing
- label: Mocking schema capabilities
href: ./development-testing/client-schema-mocking
- label: Reducing bundle size
href: ./development-testing/reducing-bundle-size
- label: Performance
children:
- label: Improving performance
href: ./performance/performance
- label: Optimistic mutation results
href: ./performance/optimistic-ui
- label: Server-side rendering
href: ./performance/server-side-rendering
- label: Compiling queries with Babel
href: ./performance/babel
- label: Integrations
children:
- label: Using Apollo Client with your view layer
href: ./integrations/integrations
- label: Integrating with React Native
href: ./integrations/react-native
- label: Loading queries with Webpack
href: ./integrations/webpack
- label: Networking
children:
- label: Basic HTTP networking
href: ./networking/basic-http-networking
- label: Advanced HTTP networking
href: ./networking/advanced-http-networking
- label: Authentication
href: ./networking/authentication
- label: Migrating
children:
- label: Migrating to Apollo Client 3.0
href: ./migrating/apollo-client-3-migration
- label: Hooks migration guide
href: ./migrating/hooks-migration
- label: API Reference
children:
- label: Core
children:
- label: ApolloClient
href: ./api/core/ApolloClient
- label: InMemoryCache
href: ./api/cache/InMemoryCache
- label: ObservableQuery
href: ./api/core/ObservableQuery
- label: React
children:
- label: Hooks
href: ./api/react/hooks
- label: Preloading
href: ./api/react/preloading
- label: Testing
href: ./api/react/testing
- label: SSR
href: ./api/react/ssr
- label: Components (deprecated)
href: ./api/react/components
- label: HOC (deprecated)
href: ./api/react/hoc
- label: Apollo Link
children:
- label: Overview
href: ./api/link/introduction
- label: HTTP
href: ./api/link/apollo-link-http
- label: HTTP Batch
href: ./api/link/apollo-link-batch-http
- label: Context
href: ./api/link/apollo-link-context
- label: Error
href: ./api/link/apollo-link-error
- label: Persisted Queries
href: ./api/link/persisted-queries
- label: Remove Typename
href: ./api/link/apollo-link-remove-typename
- label: REST
href: ./api/link/apollo-link-rest
- label: Retry
href: ./api/link/apollo-link-retry
- label: Schema
href: ./api/link/apollo-link-schema
- label: Subscriptions (newer protocol)
href: ./api/link/apollo-link-subscriptions
- label: WebSocket (older protocol)
href: ./api/link/apollo-link-ws
- label: Community links
href: ./api/link/community-links
2 changes: 1 addition & 1 deletion docs/source/api/link/apollo-link-subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const link = new GraphQLWsLink(

The `GraphQLWsLink` constructor takes a single argument, which is a `Client` returned from the `graphql-ws` `createClient` function.

The `createClient` function can take many options, described in the [`graphql-ws` docs for `ClientOptions`](https://the-guild.dev/graphql/ws/docs/interfaces/client.ClientOptions). The one required option is `url`, which is the URL (typically starting with `ws://` or `wss://`, which are the equivalents of `http://` and `https://` respectively) to your WebSocket server. (Note that this differs from the [older link's URL option](./apollo-link-ws), which is named `uri` instead of `url`.)
The `createClient` function can take many options, described in the [`graphql-ws` docs for `ClientOptions`](https://the-guild.dev/graphql/ws/docs/client/interfaces/ClientOptions). The one required option is `url`, which is the URL (typically starting with `ws://` or `wss://`, which are the equivalents of `http://` and `https://` respectively) to your WebSocket server. (Note that this differs from the [older link's URL option](./apollo-link-ws), which is named `uri` instead of `url`.)

## Usage

Expand Down
107 changes: 0 additions & 107 deletions docs/source/config.json

This file was deleted.

6 changes: 3 additions & 3 deletions docs/source/data/fragments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1135,7 +1135,7 @@ const config: CodegenConfig = {
##### With the `client-preset`
<Note>
Support for the `@unmask` directive was introduced with `@graphql-codegen/client-preset` [v4.5.1](https://github.com/dotansimha/graphql-code-generator/releases/tag/release-1732308151614)
Support for the `@unmask` directive was introduced with `@graphql-codegen/client-preset` [v4.6.0](https://github.com/dotansimha/graphql-code-generator/releases/tag/release-1738065376043)
</Note>
You can't use the `client-preset` [Fragment Masking](https://the-guild.dev/graphql/codegen/plugins/presets/preset-client#fragment-masking) and Apollo Client's data masking features simultaneously.
Expand All @@ -1157,11 +1157,11 @@ To migrate from CodeGen's fragment masking feature to Apollo Client's data maski
// ...
// disables the incompatible GraphQL Codegen fragment masking feature
fragmentMasking: false,
},
config: {
customDirectives: {
apolloUnmask: true
}
},
config: {
inlineFragmentTypes: "mask",
}
}
Expand Down
3 changes: 3 additions & 0 deletions docs/source/data/queries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,7 @@ This is the default fetch policy.
Apollo Client executes the query _only_ against the cache. It never queries your server in this case.
A `cache-only` query throws an error if the cache does not contain data for all requested fields.
</td>
Expand All @@ -454,6 +455,7 @@ A `cache-only` query throws an error if the cache does not contain data for all
Apollo Client executes the full query against both the cache _and_ your GraphQL server. The query automatically updates if the result of the server-side query modifies cached fields.
Provides a fast response while also helping to keep cached data consistent with server data.
</td>
Expand All @@ -469,6 +471,7 @@ Provides a fast response while also helping to keep cached data consistent with
Apollo Client executes the full query against your GraphQL server, _without_ first checking the cache. The query's result _is_ stored in the cache.
Prioritizes consistency with server data, but can't provide a near-instantaneous response when cached data is available.
</td>
Expand Down
Loading

0 comments on commit d8f2b5c

Please sign in to comment.