Skip to content

Commit

Permalink
Working up towards 2.0 release (#2281)
Browse files Browse the repository at this point in the history
* Fix argument for fragment matcher

* chore: Publish

 - apollo-cache-inmemory@0.2.0-beta.5
 - apollo-cache@0.2.0-beta.3
 - apollo-client-preset@0.2.0-beta.5
 - apollo-client@2.0.0-beta.5
 - apollo-utilities@0.2.0-beta.3
 - graphql-anywhere@4.0.0-beta.4

* support conditional refetches

* ensure network requests are handled on errors with cache-and-network

* make cache easier to access for SSR

* fix failing test from cache placement addition

* add test for multiple requests in flight at once

* remove direct dep on graphql

* remove connection directive before sending to link

* chore: Publish

 - apollo-client-preset@0.2.0-beta.6
 - apollo-client@2.0.0-beta.6

* handle unhanlded errors on polling queries

* chore: Publish

 - apollo-client-preset@0.2.0-beta.7
 - apollo-client@2.0.0-beta.7

* customResolvers => cacheResolvers

* micro benchmarking and reduction of mutation calls for perf gains

* changelog

* remove warning for refetching unfetched queries

* chore: Publish

 - apollo-cache-inmemory@0.2.0-beta.6
 - apollo-cache@0.2.0-beta.4
 - apollo-client-preset@0.2.0-beta.8
 - apollo-client@2.0.0-beta.8
 - apollo-utilities@0.2.0-beta.4
 - graphql-anywhere@4.0.0-beta.5

* prep for rc

* Publish

 - apollo-cache-inmemory@0.2.0-rc.0
 - apollo-cache@0.2.0-rc.0
 - apollo-client-preset@0.2.0-rc.0
 - apollo-client@2.0.0-rc.0
 - apollo-utilities@0.2.0-rc.0
 - graphql-anywhere@4.0.0-rc.0

* fix renrender bug

* put back in skipped test

* chore: Publish

 - apollo-client-preset@0.2.0-rc.1
 - apollo-client@2.0.0-rc.1

* added new rawRequest method for devTool support

* chore: Publish

 - apollo-client-preset@0.2.0-rc.2
 - apollo-client@2.0.0-rc.2

* fix subscribeToMore

* Define and expose ApolloClientOptions (#2292)

It'd be helpful to UI integration libraries such as new angular-apollo, which will be released soon.

* fix ts bug

* move off of custom zen-observable impl

* changed to named exports

* move to named imports from package changes

* turn back on testing

* chore: Publish

 - apollo-cache-inmemory@0.2.0-rc.1
 - apollo-client-preset@0.2.0-rc.3
 - apollo-client@2.0.0-rc.3

* add a couple tests for open issues

* Expose ApolloCurrentResult (#2301)

* docs(cache): added readme for apollo-cache-inmemory (#2331)

style(docs): removed order

fix(docs): minor spacing tweak

* fix(client): throw error if constructor not initialized properly (#2332)

* fix(client): throw errors if constructor not initialized properly

* fix(client): fix link to docs in error msg

* chore(changelog): added changes

* [WIP] 2.0 docs (#2324)

* More edits

* Create migration.md

* Update _config.yml

Add migration guide

* Update migration.md

* Fix 'response' typo & add hyphen to refer to possible response types

* Update simple-example.md

fixed spelling

* Update simple-example.md

* Document `.graphql` file imports in Meteor

* docs(fragments): Document import syntax

Add `import` syntax mention in the `fragments` section
Link to `webpack` page where further usage / details are provided

Closes 185

* Sanitize JSON.stringify output to prevent XSS

See these docs for rationale:
http://redux.js.org/docs/recipes/ServerRendering.html#security-considerations|

* Update fragments.md

* Update subscriptions.md

Subscription client should accept a websocket address, not an http

* docs(webpack): update webpack config to Webpack 2

* Change sketch to snack

* add docs for variables argument in docs of data.refetch

* Fix a typo

* Fix typo

immeadiately => immediately

* Fix links to server side rendering recipe

These had an extra hash in front of them

* Just Angular

* Adds a minimal mention of Direct Cache Access

And links to the relevant bit in the Vanilla JS section.

* Adds a simple example

* Update index.md

* Fix SSR link

* Use fetchPolicy for legacy forceFetch

* Changed link to point at the more relevant docs

* Fleshed out the example a bit more

* documented code for subscriptions in Meteor

* Update submodule to 1.0.3

* chore(package): update dependencies

https://greenkeeper.io/

* Revert "Update all dependencies 🌴"

* Force fetch

* Fix broken SubscriptionsServer link

* fix(package): update hexo to version 3.3.5

https://greenkeeper.io/

* Add docsearch

* Add instructions for fragment matcher

* Go back to Apollo theme

* Revert "Update hexo to the latest version 🚀"

* Upgrade hexo, fix lines

* Replace `createMeteorNetworkInterface` in `meteor.md`

`createMeteorNetworkInterface` --> `createNetworkInterface` to match function name in source code

* Revert "Replace `createMeteorNetworkInterface` with `createNetworkInterface` in `meteor.md`"

* Update api-queries.md

* Update initialization.md

* Add docs for the exposure of 'dataIdFromObject' and 'dataId'

* Add docs for the exposure of 'dataIdFromObject' and 'dataId'

* Only document dataIdFromObject

* Update fetchMore docs

Check for `fetchMoreResult`, not `fetchMoreResult.data`.

* Update subscriptions.md

* Update docs about update

* Update network.md

* Fix Example

* update mutations.md formatting

Just a quick change to the "multiple mutations" code snippet, to match the formatting style of other code snippets.

* chore(package): update typedoc to version 0.7.0

https://greenkeeper.io/

* Fixed two misspellings

* chore(submodule): update to latest

* docs(subscriptions): updated subscriptions docs

* fix typo

* Clarify createApolloServer

* Fix missing word

* Update auth.md

I think it will be really helpful to mention that `withApollo` HOC is needed to access `client`.

* add missing ApolloClient import

* Fix typos

availble -> available, respositories -> repositories

* Update read-and-write.md

* minor typo

* changes per @rdickert comments on #274

* add ts typings

* Use correct property name in how-it-works.md 

The documentation states that the property is called dataIdFromObject, but the example uses dataFromObjectId instead.
When trying it out, it did work with dataIdFromObject, but not with dataFromObjectId.

* docs cleanup + additions for parsed afterware response

* Update network.md

* Make language a bit clearer

* Printer is no longer in graphql-tag

apollographql/graphql-tag#54

* GTM

* Update theme

* Add GTM

* Updated incorrect link to Mutations: Update

* Document the expected updateQuery return value

By specifying that it should have the same shape as the original query data.

* Update subscriptions.md

* subscribeToMore returns unsubscribe handler

* subscribeToMore returns unsubscribe handler

>@deep-c It's not defined because you're not actually getting an observable back. Apollo Client subscribes to it for you, so all you get back is actually the unsubscribe handle. So if you call this.subscription() it will unsubscribe. Maybe the variable name I chose in GitHunt-React isn't great 😄 . Would be better to call it unsubscribeHandle or something.

#1145 (comment)

* Fix missing variables in docs for refetchQueries

* Fix typo

* Add an example of a custom network interface

* Update network.md

* Syntax highlighting

Sorry, just realized I left off the js syntax highlighting

* - Adds intro text

* - Adds intro text

* - Adds queries
- Adds resolverCode

* - Adds queries
- Adds resolverCode

* Update partial-data.md

- Adds code example
- Fixes query
- Fixes wordings

* - Changes some wordings

* - Changes some wordings
- Adds paragraph about query batching

* - Changes wording scene to view

* - Adds link to custom resolvers

* - Changes title of the page
- Changes some wordings
- Adds link to BatchedNetworkInterface API docs

* - Applies suggested changes
- Adds destructuring for better readability

* Change the endpoint URI to the less misleading one

People don't usually use `http://localhost:3000/` as their endpoint for graphql,
I think it might be more understandable what it is if we use `http://localhost:3000/graphql` as example.

* Only send request cookie rather than full headers (See #228)

* Fix syntax error in fetchMore example

* Added batchMax to the Query batching explanation.

* tell typedoc to ignore compiler errors

* Fix broken `config.options` links for Queries and Mutations

* Fix broken generic `config.options` link

* Add documentation for the new connection directive

* Bump Node version to try to make CircleCI tests pass

* Update api-server.md

Added some corrections.

* Fix unexpected token error in example code

* Remove inaccurate part about parsed results in afterware

* Update network.md

Removing not necessary else on example code.

* Fixed link to angular page

Link pointed to /angular, which returns a 403

* Fix broken link in simple-example

* fixed typo in api-mutations.md

Changed "excepted" to "accepted".

* Update for new filter argument

* Update cache-updates.md

* Typo for Hello World link

* fix(package): update hexo to version 3.3.8

* fix(package): update hexo to version 3.3.8

* added docs for static typing (#258)

* added docs for static typing

* update from feedback

* spelling

* update class for flow since it can infer

* Improve customResolvers documentation

Add note about having to be the same data, add note about where to get `__typename`, improve overall documentation

* mention that options.context can be a function

* Minor typo fix

* Add unit of time for batchInterval in query batching description

* Remove wording about "just like above"

The previous example is actually only implementing `optimisticResponse` but then the next example implements `update` as well as `optimisticResponse`, and I found the wording to be a bit confusing around this. Do we need to implement `update` as well as `optimisticResponse` as the example shows for adding to a list? If so, the wording was incorrect. If not, then it'd be ideal to give an example where only `optimisticResponse` is required for adding to a list.

I'm currently assuming that the wording was actually slightly off, and that `update` was in fact necessary, in which case we can just remove the bit about `update` not being required.

* fix example; cursor is not available on root

* Update pagination.md

* Change "Expo Sketch" to "Expo Snack"

* Update SSR for React docs to reflect newest version of React Router

* Add relevant comment on routes file

* Add link to FuseBox plugin

* Fix createMeteorNetworkInterface in SSR section

* Fix typo in optimistic-ui.md

* Add gql to the list of imports

gql is used to create the graphql query for the Profile component so it has to be imported to work.

* fixed typo, sentence rewording in query-splitting

* update docs: PropTypes is now a separate package

* Query docs: PropTypes is now a separate package

* Updated simple-example.md

Move to the updated link on howtographql.com as learnapollo.com is deprecated. Please let me know if I need to change the label as well or if this is not relevant.

* Update SSR doc based on feedback.

* StaticRouter now wrapped in ApolloProvider, and made routes example more specific

* Update simple-example.md

Change 2nd tutorial title from "Learn Apollo" to "How to GraphQL" as the prior is deprecated.

* Fixed small typo in example

* Update index.md

Move to the updated link on howtographql.com as learnapollo.com is deprecated.

* adding a super simple client/server example

This repo is just a simple playground for GraphQL n00bs like me. It's only `client.js` and `server.js` both under 50 lines.

Having a minimalist sandbox like this helped me wrap my mind around Apollo, before I started adding all the ceremony that comes along with a UI and database.

Thanks!

* Small typo in refetchQueries example

Small typo in refetchQueries example. The variable name is incorrect in the mutation of refetchQueries example.

* Add slack button

* try edit

* Try changing versions

* Fix outdated queryDeduplication docs

* doc/link formatting

* forceFetch -> fetchPolicy

change `forceFetch: true` to `fetchPolicy: 'network-only'`

* Sync the SSR doc with the newest update added to the GitHunt app, which now uses React Router v4

* Add package lock

* Fix internal link

* move to core-docs

* adjust config and fix jsdoc

* track public

* Add docs for graphql-tag precompilation with babel (#292)

* Add rootEl const to redux.md example code (#293)

In your DOM rendering, you threw in rootEl, but rootEl was never defined. Assuming the ID is "root", I added a const that pointed to that div/element.

`const rootEl = document.querySelector("#root");`

* Update index.md (#295)

* Update auth.md (#296)

* fragment -> fragments (#297)

The component field is named `fragments`, not `fragment`.

* Add React native case (#299)

* docs(fragment matcher): added build script, revised docs for 2.0 (#302)

* Update using-with-types.md (#298)

* add note about refetch variables (#300)

add brief note to clear any variables that were set before for any query. This is helpful when you want to omit a variable from the query that was set before. e.g in case of filters you might want to clear previous filter variable but by not passing that variable will result in picking the old value.

* Docs reorg (#2339)

* start reorg

* reorg of docs for test deploy [NOT READY]

* remove built docs

* update gitignore

* Fix submodule path

* Fix submodule issues
  • Loading branch information
James Baxley authored Oct 19, 2017
1 parent e2b4525 commit 2cd695f
Show file tree
Hide file tree
Showing 100 changed files with 7,301 additions and 376 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,10 @@ yarn.lock

# npm
package-lock.json

# docs
db.json
*.log
docs/public/*
!docs/public/_redirects
.idea/
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/themes/meteor"]
path = docs/themes/meteor
url = https://github.com/meteor/hexo-theme-meteor.git
23 changes: 12 additions & 11 deletions Upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ If you are interested in contributing to the 2.0 release that is SO great!! Ther
## Installation instructions
The 2.0 of apollo is split into a few packages. To try it out in your app you can install the following
```bash
npm i --save apollo-client@beta apollo-cache-inmemory@beta apollo-link-http@beta
npm i --save apollo-client@next apollo-cache-inmemory@next apollo-link-http
```

This will give you the replacement for networkInterfaces (links), the current apollo-cache (cache-inmemory) and the new client.
Expand Down Expand Up @@ -83,16 +83,16 @@ import { onPageLoad } from 'meteor/server-render';

// apollo imports
import ApolloClient from 'apollo-client';
import Link from 'apollo-link-http';
import Cache from 'apollo-cache-inmemory'
import { HttpLink } from 'apollo-link-http';
import { InMemoryCache } from 'apollo-cache-inmemory'
import { ApolloProvider } from 'react-apollo';

import { App } from '/imports/app';

export const start = () => {
const client = new ApolloClient({
link: new Link({ uri: 'http://localhost:3000' }),
cache: new Cache().restore(window.__APOLLO_STATE__),
link: new HttpLink({ uri: 'http://localhost:3000' }),
cache: new InMemoryCache().restore(window.__APOLLO_STATE__),
});

const WrappedApp = (
Expand Down Expand Up @@ -128,20 +128,22 @@ becomes

```js
import ApolloClient from "apollo-client";
import InMemoryCache from "apollo-cache-inmemory";
import { InMemoryCache } from "apollo-cache-inmemory";

const cache = new InMemoryCache({
fragmentMatcher: // matcher,
dataIdFromObject: // custom function,
addTypename: true,
customResolvers: // custom resolvers
cacheResolvers: // cache resolvers
});

const client = new ApolloClient({
cache: cache.restore(window.__APOLLO_STATE__ || {})
});
```

*Note* If you were using `customResolvers`, the name of that has been changed to be `cacheResolvers` to be more descriptive of what it does. `customResolvers` will still be supported throughout the 2.0 though to be backwards compatible and ease the upgrade path


If you have previously used `getInitialState` for SSR, that API has been moved to the cache itself instead of on the client. The before:

Expand All @@ -159,14 +161,13 @@ becomes

```js
import ApolloClient from "apollo-client";
import InMemoryCache from "apollo-cache-inmemory";
import { InMemoryCache } from "apollo-cache-inmemory";

const cache = new InMemoryCache();
const client = new ApolloClient({ cache });
const client = new ApolloClient({ cache: new InMemoryCache() });

// do some data loading things using getDataFromTree

const state = cache.extract();
const state = client.cache.extract();
```


Expand Down
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# docs

[![Greenkeeper badge](https://badges.greenkeeper.io/apollographql/core-docs.svg)](https://greenkeeper.io/)

To run:

```
git submodule init
git submodule update
cd code && npm install
cd ..
npm install
npm start
```
125 changes: 125 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# Hexo Configuration
## Docs: http://hexo.io/docs/configuration.html
## Source: https://github.com/hexojs/hexo/

# Site
title: Apollo Client Guide
propertytitle: Using GraphQL with Apollo Client
subtitle: React Guide
description: A guide to using the Apollo GraphQL Client with React.
author:
language:
timezone:
versions:
- '1'

# This setting also defines the page order used to generate the Previous/Next links at the bottom of each page
sidebar_categories:
# Basics
null:
- index
- basics/integrations
- basics/setup
- basics/queries
- basics/mutations
- basics/network-layer
- basics/error-handling
- basics/fragments
- basics/subscriptions
Features:
- features/changelog
- features/caching
- features/developer-tooling
- features/network-customization
- features/optimistic-ui
- features/react-native
- features/static-typing
Recipes:
- recipes/authentication
- recipes/babel
- recipes/meteor
- recipes/pagination
- recipes/prefetching
- recipes/query-splitting
- recipes/server-side-rendering
- recipes/simple-example
- recipes/webpack
# - recipes/client-side-data
# - recipes/using-with-rest
# - recipes/offline
# - recipes/custom-fetching
Reference:
- reference/index


github_repo: apollographql/apollo-client
content_root: docs/source

social_links:
github: 'https://github.com/apollographql'
twitter: '@apollographql'

# API keys
apis:
segment: wgrIo8Bul0Ujl8USETG3DB6hONdy4kTg
gtm: GTM-PNFDVBB

# URL
## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
url: https://www.apollographql.com/docs/react
root: /docs/react/
permalink: :year/:month/:day/:title/
permalink_defaults:

# Directory
source_dir: source
public_dir: public/docs/react
tag_dir: tags
archive_dir: archives
category_dir: categories
code_dir: downloads/code
i18n_dir: :lang
skip_render:

# Writing
new_post_name: :title.md # File name of new posts
default_layout: post
titlecase: false # Transform title into titlecase
external_link: true # Open external links in new tab
filename_case: 0
render_drafts: false
post_asset_folder: false
relative_link: false
future: true
highlight:
enable: true
line_number: true
auto_detect: true
tab_replace:

# Category & Tag
default_category: uncategorized
category_map:
tag_map:

# Date / Time format
## Hexo uses Moment.js to parse and display date
## You can customize the date format as defined in
## http://momentjs.com/docs/#/displaying/format/
date_format: YYYY-MM-DD
time_format: HH:mm:ss

# Pagination
## Set per_page to 0 to disable pagination
per_page: 10
pagination_dir: page

# Extensions
## Plugins: http://hexo.io/plugins/
## Themes: http://hexo.io/themes/
theme: meteor

# Deployment
## Docs: http://hexo.io/docs/deployment.html
deploy:
type:
1 change: 1 addition & 0 deletions docs/assets/theme-colors.less
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@color-primary: #22A699;
23 changes: 23 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "hexo-site",
"version": "0.0.0",
"private": true,
"hexo": {
"version": "3.3.8"
},
"dependencies": {
"hexo": "3.3.8",
"hexo-generator-archive": "^0.1.2",
"hexo-generator-category": "^0.1.2",
"hexo-generator-index": "^0.2.0",
"hexo-generator-tag": "^0.2.0",
"hexo-renderer-ejs": "^0.2.0",
"hexo-renderer-less": "^0.2.0",
"hexo-renderer-marked": "^0.2.4",
"hexo-server": "^0.2.0"
},
"scripts": {
"build": "hexo generate",
"start": "hexo serve"
}
}
1 change: 1 addition & 0 deletions docs/public/_redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/ /docs/react/
Binary file added docs/source/assets/client-diagrams/1-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/client-diagrams/2-map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/client-diagrams/3-minimize.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/devtools/devtools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/devtools/mutation-init.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/devtools/mutation-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/devtools/query-init-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/devtools/query-init.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/devtools/query-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions docs/source/basics/error-handling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Error Handling
subtitle: Subtitle
description: Description
---

<h2 title="topic">Topic</h2>

<h3 title="subtopic">Sub Topic</h3>

```js
// code block
```

<h2 title="best-practices">Best Practices</h2>

<h2 title="API">API Documentation</h2>
Loading

0 comments on commit 2cd695f

Please sign in to comment.