Skip to content

feat(data): add GraphQL API optimistic UI docs #5572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
katieklein merged 27 commits into from
Jun 29, 2023
Merged

feat(data): add GraphQL API optimistic UI docs #5572

katieklein merged 27 commits into from
Jun 29, 2023

Conversation

@david-mcafee
Copy link
Contributor

@david-mcafee david-mcafee commented Jun 18, 2023 •
edited
Loading

Description of changes:

feat(data): add GraphQL API optimistic UI docs

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • iOS
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://link.com)
    HTML: <a href="https://link.com">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@david-mcafee david-mcafee requested review from a team and renebrandel June 18, 2023 21:43
@david-mcafee david-mcafee self-assigned this Jun 18, 2023
@david-mcafee david-mcafee added example Examples that would describe how to use Amplify in specific situations docs amplify/data Issue related to aws-amplify/amplify-category-api API GraphQL amplify/js Issues tied to JS guides in-progress do-not-merge technical-review-needed labels Jun 18, 2023
renebrandel
renebrandel reviewed Jun 19, 2023
View reviewed changes
renebrandel
renebrandel reviewed Jun 19, 2023
View reviewed changes
renebrandel
renebrandel reviewed Jun 19, 2023
View reviewed changes
renebrandel
renebrandel reviewed Jun 19, 2023
View reviewed changes
renebrandel
renebrandel reviewed Jun 23, 2023
View reviewed changes
renebrandel
renebrandel reviewed Jun 26, 2023
View reviewed changes
@katieklein
Copy link
Contributor

katieklein commented Jun 26, 2023

@david-mcafee - It looks like optimstical needs to be added to the cspell doc. Thanks!

@katieklein katieklein added the product-owner-review-needed Current step in the approval process requires a PM review label Jun 26, 2023
iartemiev
iartemiev reviewed Jun 26, 2023
View reviewed changes
@david-mcafee
Copy link
Contributor Author

david-mcafee commented Jun 27, 2023

@david-mcafee - It looks like optimstical needs to be added to the cspell doc. Thanks!

This is actually a typo that exist in the TanStack Query docs (should be optimistical). I think optimistic value makes the most sense grammatically here, but let me know if you disagree! :)

kevinold
kevinold reviewed Jun 27, 2023
View reviewed changes
@david-mcafee david-mcafee force-pushed the optimistic-ui branch 2 times, most recently from ce15831 to 768a465 Compare June 27, 2023 20:32
renebrandel
renebrandel reviewed Jun 29, 2023
View reviewed changes
renebrandel
renebrandel reviewed Jun 29, 2023
View reviewed changes
renebrandel
renebrandel reviewed Jun 29, 2023
View reviewed changes
david-mcafee and others added 2 commits June 29, 2023 09:50
@david-mcafee @renebrandel @iartemiev
Apply suggestions from code review
fc3006e 
Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
Co-authored-by: Ivan Artemiev <29709626+iartemiev@users.noreply.github.com>
@david-mcafee
address PR feedback
0da703b
@katieklein katieklein merged commit 428de03 into main Jun 29, 2023
@katieklein katieklein deleted the optimistic-ui branch June 29, 2023 17:36
@katieklein katieklein removed product-owner-review-needed Current step in the approval process requires a PM review technical-review-needed do-not-merge labels Jun 29, 2023
katieklein added a commit that referenced this pull request Jul 24, 2023
@katieklein @lavr001
@david-mcafee @renebrandel @iartemiev @dependabot @atierian @ankpshah @timngyn @cwomack @devnotfound @hibler13 @fjnoyp @royjit @phantumcode @jacoblogan @nadetastic @cshfang @srquinn21
Jtbd expander (#5682)
66a7a87 
* accordion prototype in progress

* accordion in progress

* accordion is in progress

* accordion prototype is completed

* Adding upgrade guide for Apollo SDK

* added Upgrade Guide content

* feat(data): add GraphQL API optimistic UI docs (#5572)

* feat(data): add GraphQL API optimistic UI docs

* GraphQL API optimistic UI docs updates

* GraphQL API optimistic UI docs updates; update dictionary

* Update src/fragments/lib/graphqlapi/js/optimistic-ui.mdx

Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>

* update API + Storage docs phrasing

* Update src/fragments/lib/graphqlapi/js/optimistic-ui.mdx

Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>

* Update src/fragments/lib/graphqlapi/js/optimistic-ui.mdx

Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>

* update link

* add preliminary callout

* optimistic ui + api docs updates

* address PR feedback

* update optimistic UI + api complete TS example

* update optimistic UI + API docs

* update getting started, code examples, and callouts

* add code samples and docs for all CRUD operations

* add section on loading and error states

* update loading / error states section, update callout, update final example, add additional docs content

* update guidance for interacting with the cache on update

* update phrasing

* address PR feedback

* add all JS code examples; reformat TS examples

* address PR feedback

* Apply suggestions from code review

Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
Co-authored-by: Ivan Artemiev <29709626+iartemiev@users.noreply.github.com>

* address PR feedback

---------

Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
Co-authored-by: Ivan Artemiev <29709626+iartemiev@users.noreply.github.com>

* Update [platform].mdx

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/directory/directory.mjs

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update getting started first paragraph wording (#5570)

* Update getting started first paragraph wording

* Update src/pages/start/q/integration/[integration].mdx

Co-authored-by: Katie Goines <30757403+katiegoines@users.noreply.github.com>

---------

Co-authored-by: Katie Goines <30757403+katiegoines@users.noreply.github.com>

* Update storage.mdx

* fixed a formatting issue

* chore(deps): bump @aws-amplify/ui-react from 5.0.2 to 5.0.3 (#5593)

Bumps [@aws-amplify/ui-react](https://github.com/aws-amplify/amplify-ui/tree/HEAD/packages/react) from 5.0.2 to 5.0.3.
- [Release notes](https://github.com/aws-amplify/amplify-ui/releases)
- [Changelog](https://github.com/aws-amplify/amplify-ui/blob/main/packages/react/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-ui/commits/@aws-amplify/ui-react@5.0.3/packages/react)

---
updated-dependencies:
- dependency-name: "@aws-amplify/ui-react"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* update swift prereq for visionOS preview support (#5598)

* Addresses #5604 (#5616)

* Amplify Android: replace deprecated id with identifier method (#5613)

* replace deprecated id with identifier method

* fix indentation

* Fix formatting

* Handle AmplifyException separately before delete

* Handle AmplifyException separately before update

* Handle AmplifyException separately before delete

* Update deleted assets workflow (#5591)

* Update deleted assets workflow

* Refactor redirects label workflow to use add_label_for_deleted_files.js

* Update mergify.yml to remove adding the deleted-assets label

* Update job name and some fixes

* chore(JS): Add confirmSignIn() flows to JS sign in docs (#5566)

* update React Native dependency installations to INCLUDE `amazon-cognito-identity-js` or REMOVE `core-js` as needed

* add confirmSignIn() flows to JS sign in docs

* minor fixes to preamble

* updates to signInWithCustomChallenge code snippet

* updated confirmSignIn() example to use variable passed in and fixed phrasing/typo.

* update signInWithMFA function after getting additional clarity

* Latest npm init vue support (#5429)

* Add TS examples for getting-started pages of the Auth category (#5587)

* Initial commit

* chore:address PR feedback

* chore:add mfa ts and js examples (#3)

Co-authored-by: idevk <idevk@amazon.com>

* Revert "chore:add mfa ts and js examples (#3)"

This reverts commit ef0305f.

---------

Co-authored-by: idevk <idevk@amazon.com>

* chore(deps): bump @aws-amplify/graphql-transformer-interfaces (#5605)

Bumps [@aws-amplify/graphql-transformer-interfaces](https://github.com/aws-amplify/amplify-category-api/tree/HEAD/packages/amplify-graphql-transformer-interfaces) from 2.2.2 to 2.2.3.
- [Release notes](https://github.com/aws-amplify/amplify-category-api/releases)
- [Changelog](https://github.com/aws-amplify/amplify-category-api/blob/main/packages/amplify-graphql-transformer-interfaces/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-category-api/commits/@aws-amplify/graphql-transformer-interfaces@2.2.3/packages/amplify-graphql-transformer-interfaces)

---
updated-dependencies:
- dependency-name: "@aws-amplify/graphql-transformer-interfaces"
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* added aria-label to the search box (#5612)

* Revert aa order (#5628)

* Revert "Reorder AA scripts (#5575)"

This reverts commit ea0b58a.

* test amplify yml changes

* test env var

* test env var

* Update env var reference

* update in customhttp.yml

* chore(deps): bump @aws-amplify/ui-react from 5.0.3 to 5.0.4 (#5626)

Bumps [@aws-amplify/ui-react](https://github.com/aws-amplify/amplify-ui/tree/HEAD/packages/react) from 5.0.3 to 5.0.4.
- [Release notes](https://github.com/aws-amplify/amplify-ui/releases)
- [Changelog](https://github.com/aws-amplify/amplify-ui/blob/main/packages/react/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-ui/commits/@aws-amplify/ui-react@5.0.4/packages/react)

---
updated-dependencies:
- dependency-name: "@aws-amplify/ui-react"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat(data): update code examples for optimistic UI docs - update types, update return value for mutation hooks, and add additional cache invalidation (#5602)

* feat(data): update types in code examples for optimistic UI docs

* feat(data): update types in code examples for optimistic UI docs

* Update getting started first paragraph wording (#5570)

* Update getting started first paragraph wording

* Update src/pages/start/q/integration/[integration].mdx

Co-authored-by: Katie Goines <30757403+katiegoines@users.noreply.github.com>

---------

Co-authored-by: Katie Goines <30757403+katiegoines@users.noreply.github.com>

* Adding upgrade guide for Apollo SDK

* added Upgrade Guide content

* Update [platform].mdx

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/directory/directory.mjs

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/lib/graphqlapi/upgrade-guide/q/platform/[platform].mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* fixed a formatting issue

* Update storage.mdx

* chore(deps): bump @aws-amplify/ui-react from 5.0.2 to 5.0.3 (#5593)

Bumps [@aws-amplify/ui-react](https://github.com/aws-amplify/amplify-ui/tree/HEAD/packages/react) from 5.0.2 to 5.0.3.
- [Release notes](https://github.com/aws-amplify/amplify-ui/releases)
- [Changelog](https://github.com/aws-amplify/amplify-ui/blob/main/packages/react/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-ui/commits/@aws-amplify/ui-react@5.0.3/packages/react)

---
updated-dependencies:
- dependency-name: "@aws-amplify/ui-react"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* update swift prereq for visionOS preview support (#5598)

* Addresses #5604 (#5616)

* Amplify Android: replace deprecated id with identifier method (#5613)

* replace deprecated id with identifier method

* fix indentation

* Fix formatting

* Handle AmplifyException separately before delete

* Handle AmplifyException separately before update

* Handle AmplifyException separately before delete

* Update deleted assets workflow (#5591)

* Update deleted assets workflow

* Refactor redirects label workflow to use add_label_for_deleted_files.js

* Update mergify.yml to remove adding the deleted-assets label

* Update job name and some fixes

* chore(JS): Add confirmSignIn() flows to JS sign in docs (#5566)

* update React Native dependency installations to INCLUDE `amazon-cognito-identity-js` or REMOVE `core-js` as needed

* add confirmSignIn() flows to JS sign in docs

* minor fixes to preamble

* updates to signInWithCustomChallenge code snippet

* updated confirmSignIn() example to use variable passed in and fixed phrasing/typo.

* update signInWithMFA function after getting additional clarity

* Latest npm init vue support (#5429)

* Add TS examples for getting-started pages of the Auth category (#5587)

* Initial commit

* chore:address PR feedback

* chore:add mfa ts and js examples (#3)

Co-authored-by: idevk <idevk@amazon.com>

* Revert "chore:add mfa ts and js examples (#3)"

This reverts commit ef0305f.

---------

Co-authored-by: idevk <idevk@amazon.com>

* chore(deps): bump @aws-amplify/graphql-transformer-interfaces (#5605)

Bumps [@aws-amplify/graphql-transformer-interfaces](https://github.com/aws-amplify/amplify-category-api/tree/HEAD/packages/amplify-graphql-transformer-interfaces) from 2.2.2 to 2.2.3.
- [Release notes](https://github.com/aws-amplify/amplify-category-api/releases)
- [Changelog](https://github.com/aws-amplify/amplify-category-api/blob/main/packages/amplify-graphql-transformer-interfaces/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-category-api/commits/@aws-amplify/graphql-transformer-interfaces@2.2.3/packages/amplify-graphql-transformer-interfaces)

---
updated-dependencies:
- dependency-name: "@aws-amplify/graphql-transformer-interfaces"
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* added aria-label to the search box (#5612)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Abdallah Shaban <awshaban@amazon.com>
Co-authored-by: Katie Goines <30757403+katiegoines@users.noreply.github.com>
Co-authored-by: Rene Brandel <renbran@amazon.com>
Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Ian Saultz <52051793+atierian@users.noreply.github.com>
Co-authored-by: Ankit Shah <22114629+ankpshah@users.noreply.github.com>
Co-authored-by: Tim Nguyen <54393192+timngyn@users.noreply.github.com>
Co-authored-by: Chris Womack <67726635+cwomack@users.noreply.github.com>
Co-authored-by: devnotfound <devendra.khanolkar@yahoo.com>
Co-authored-by: idevk <idevk@amazon.com>
Co-authored-by: Roman <lavrenr@amazon.com>

* Updating text in Quickstart section (#5642)

* Updating description of Amplify Badge program (#5641)

* Updating wording in How it Works section (#5639)

* fix(amplify_flutter): datastore hub example (#5629)

* fix(amplify_flutter): datastore hub example

* Update hubSubscription type

* minor

* fix

* Fix SavePosts example (#5621)

* fix(storage): Add information about request options (#5611)

* fix(storage): Add information about request options

* Fix code format

* update swift storage escape hatch SDK documentation links (#5608)

* update swift storage category upload (#5607)

* update swift storage category upload

* update for PR comment

* update for PR comment

* add contribute getting-started page to directory (#5643)

* add contribute getting-started page to directory

* move contribute getting started to pathMap

---------

Co-authored-by: Jacob Logan <lognjc@amazon.com>

* chore(deps): bump @aws-amplify/graphql-transformer-interfaces (#5634)

Bumps [@aws-amplify/graphql-transformer-interfaces](https://github.com/aws-amplify/amplify-category-api/tree/HEAD/packages/amplify-graphql-transformer-interfaces) from 2.2.3 to 2.2.4.
- [Release notes](https://github.com/aws-amplify/amplify-category-api/releases)
- [Changelog](https://github.com/aws-amplify/amplify-category-api/blob/main/packages/amplify-graphql-transformer-interfaces/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-category-api/commits/@aws-amplify/graphql-transformer-interfaces@2.2.4/packages/amplify-graphql-transformer-interfaces)

---
updated-dependencies:
- dependency-name: "@aws-amplify/graphql-transformer-interfaces"
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Call out for expires param when calling Storage.get(0 (#5647)

* feat(storage): supporting put api when the objectLock is enabled  (#5644)

* chore: add isObjectLockEnabled in configure

* chore: remove extra space

* chore: update wording

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

---------

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

* update userID code snippet for Push Notifications and Flutter (#5640)

* update userID code snippet for Push Notifications and Flutter

update userID code snippet for Push Notifications and Flutter

* Update 10_get_auth_user.mdx

* Provides recommendation to isolate Amplify workloads by account (#5650)

Co-authored-by: ⛵️ Sean Quinn <srquinn@amazon.com>

* new sample text

* fix scroll

* hiding toc entries for headings in expander

* working on scroll

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Roman Lavrenov <lavrenr@amazon.com>
Co-authored-by: Rene Brandel <renbran@amazon.com>
Co-authored-by: David McAfee <mcafd@amazon.com>
Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
Co-authored-by: Ivan Artemiev <29709626+iartemiev@users.noreply.github.com>
Co-authored-by: Abdallah Shaban <awshaban@amazon.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Ian Saultz <52051793+atierian@users.noreply.github.com>
Co-authored-by: Ankit Shah <22114629+ankpshah@users.noreply.github.com>
Co-authored-by: Tim Nguyen <54393192+timngyn@users.noreply.github.com>
Co-authored-by: Chris Womack <67726635+cwomack@users.noreply.github.com>
Co-authored-by: devnotfound <devendra.khanolkar@yahoo.com>
Co-authored-by: idevk <idevk@amazon.com>
Co-authored-by: Jim Eagan <84857865+hibler13@users.noreply.github.com>
Co-authored-by: kc <kylcheng@gmail.com>
Co-authored-by: Jithin Roy <51138777+royjit@users.noreply.github.com>
Co-authored-by: Tuan Pham <103537251+phantumcode@users.noreply.github.com>
Co-authored-by: jacoblogan <jacob.maiola.logan@gmail.com>
Co-authored-by: Jacob Logan <lognjc@amazon.com>
Co-authored-by: Dan Kiuna <dkkiuna@amazon.com>
Co-authored-by: Venkata Ramyasri Kota <34170013+kvramyasri7@users.noreply.github.com>
Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>
Co-authored-by: Sean R. Quinn <srquinn21@users.noreply.github.com>
Co-authored-by: ⛵️ Sean Quinn <srquinn@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kevinold kevinold Awaiting requested review from kevinold

@iartemiev iartemiev Awaiting requested review from iartemiev

2 more reviewers

@renebrandel renebrandel renebrandel approved these changes

@katieklein katieklein katieklein approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@david-mcafee david-mcafee

Labels

amplify/data Issue related to aws-amplify/amplify-category-api amplify/js Issues tied to JS API GraphQL docs example Examples that would describe how to use Amplify in specific situations guides in-progress

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@david-mcafee @katieklein @kevinold @renebrandel @iartemiev