Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
{"[ Not functional, but the examples are still valid ]"->React.string}
12 | {switch SorryItsNotASubscriptionForTodos.use() { 13 | | {data: Some({siteStatisticsUpdated: Some({currentVisitorsOnline})})} => 14 |15 | {React.string("There are " ++ (string_of_int(currentVisitorsOnline) ++ " visitors online"))} 16 |
17 | | _ignoredForExample => React.null 18 | }} 19 | 20 | -------------------------------------------------------------------------------- /src/@apollo/client/core/ApolloClient__Core_NetworkStatus.res: -------------------------------------------------------------------------------- 1 | module NetworkStatus = { 2 | module Js_ = { 3 | type t = int 4 | } 5 | 6 | type t = 7 | | Loading 8 | | SetVariables 9 | | FetchMore 10 | | Refetch 11 | | Poll 12 | | Ready 13 | | Error 14 | | // Apollo types are not accurate. See: 15 | // https://github.com/reasonml-community/rescript-apollo-client/issues/68 16 | SkippedOrNotPresent 17 | 18 | let fromJs: Js_.t => t = js => 19 | switch js { 20 | | 1 => Loading 21 | | 2 => SetVariables 22 | | 3 => FetchMore 23 | | 4 => Refetch 24 | | 6 => Poll 25 | | 7 => Ready 26 | | 8 => Error 27 | | _ => SkippedOrNotPresent 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /EXAMPLES/src/hooksUsage/Query_OverlySimple.res: -------------------------------------------------------------------------------- 1 | module TodosQuery = %graphql(` 2 | query TodosQuery { 3 | todos: allTodos { 4 | id 5 | text 6 | completed 7 | } 8 | } 9 | `) 10 | 11 | @react.component 12 | let make = () => 13 | switch TodosQuery.use() { 14 | | {loading: true} => "Loading..."->React.string 15 | | {error: Some(_error)} => "Error loading data"->React.string 16 | | {data: Some({todos})} => 17 |
18 | {"There are "->React.string}
19 | {todos->Belt.Array.length->React.int}
20 | {" To-Dos"->React.string}
21 |
22 | | {data: None, error: None, loading: false} =>
23 | "I hope this is impossible, but sometimes it's not!"->React.string
24 | }
25 |
--------------------------------------------------------------------------------
/src/@apollo/client/link/utils/ApolloClient__Link_Utils_ThrowServerError.res:
--------------------------------------------------------------------------------
1 | /* export declare const throwServerError: (response: Response, result: any, message: string) => never */
2 |
3 | module ServerError = {
4 | module Js_ = {
5 | // export declare type ServerError = Error & {
6 | // response: Response;
7 | // result: Record
2 | 
3 |
4 | ReScript bindings for the Apollo Client ecosystem
5 |
8 |
9 | 
10 |
11 |
14 | Documentation • 15 | Installation • 16 | Examples • 17 | Contributing 18 |
19 | -------------------------------------------------------------------------------- /documentationWebsite/src/css/custom.css: -------------------------------------------------------------------------------- 1 | /* stylelint-disable docusaurus/copyright-header */ 2 | /** 3 | * Any CSS included here will be global. The classic template 4 | * bundles Infima by default. Infima is a CSS framework designed to 5 | * work well for content-centric websites. 6 | */ 7 | 8 | /* You can override the default Infima variables here. */ 9 | :root { 10 | --ifm-color-primary: #933485; 11 | --ifm-color-primary-dark: #842f78; 12 | --ifm-color-primary-darker: #7d2c71; 13 | --ifm-color-primary-darkest: #67245d; 14 | --ifm-color-primary-light: #a23992; 15 | --ifm-color-primary-lighter: #a93c99; 16 | --ifm-color-primary-lightest: #bd45ac; 17 | --ifm-code-font-size: 95%; 18 | } 19 | 20 | .white-bg { 21 | background: white; 22 | } -------------------------------------------------------------------------------- /src/@apollo/client/link/ws/ApolloClient__Link_Ws.res: -------------------------------------------------------------------------------- 1 | module ApolloLink = ApolloClient__Link_Core_ApolloLink 2 | module Graphql = ApolloClient__Graphql 3 | 4 | module WebSocketLink = { 5 | module ClientOptions = ApolloClient__GraphqlWs.ClientOptions 6 | module Client = ApolloClient__GraphqlWs.Client 7 | 8 | module Js_ = { 9 | // export class GraphQLWsLink extends ApolloLink { 10 | // constructor(public readonly client: Client); 11 | // request(operation: Operation): Observable{"Fetching Data with Hooks"->React.string}
5 |{"Simple Query"->React.string}
6 |{"Typical Query"->React.string}
8 |{"Lazy Query"->React.string}
10 |{"Mutation"->React.string}
12 |{"Subcription"->React.string}
14 |{"Query with Subscription for More"->React.string}
16 |{"Fetching Data Directly with the Client"->React.string}
18 |{"Fragments"->React.string}
20 |
15 | {switch queryResult {
16 | | Unexecuted(_) =>
17 | <>
18 | {"Waiting to be executed... "->React.string}
19 |
22 |
23 | | Executed({loading: true, data: None}) =>
40 | }
41 |
--------------------------------------------------------------------------------
/src/@apollo/client/link/retry/ApolloClient__Link_Retry_RetryFunction.res:
--------------------------------------------------------------------------------
1 | module Operation = ApolloClient__Link_Core.Types.Operation
2 |
3 | module RetryFunction = {
4 | module Js_ = {
5 | // export interface RetryFunction {
6 | // (count: number, operation: Operation, error: any): boolean | Promise{"Loading"->React.string}
24 | | Executed({loading, data: Some({todos}), error}) => 25 | <> 26 | 33 |34 | {React.string("There are " ++ (todos->Belt.Array.length->string_of_int ++ " To-Dos"))} 35 |
36 | 37 | | Executed({loading: false, data: None}) =>{"Error loading data"->React.string}
38 | }} 39 |{React.string("There are " ++ (todos->Belt.Array.length->string_of_int ++ " To-Dos"))}
18 | } 19 | 20 | @react.component 21 | let make = () => { 22 | let queryResult = TodosQuery.use() 23 | 24 |
25 | {switch queryResult {
26 | | {loading: true, data: None} =>
41 | }
42 |
--------------------------------------------------------------------------------
/docs/assets/js/c4f5d8e4.2a22f74f.js:
--------------------------------------------------------------------------------
1 | "use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[634],{1802:(e,t,r)=>{r.r(t),r.d(t,{default:()=>m});var n=r(6540),a=r(53),o=r(4492),i=r(5489),s=r(4586),c=r(6025);const l={section:"section_rC2D",featureImage:"featureImage_yA8i",hero:"hero_syme",heroInner:"heroInner_VWeJ",heroProjectTagline:"heroProjectTagline_EkV5",heroLogo:"heroLogo_jM6J",jackInTheBox:"jackInTheBox_S9I6",index:"index_MEVg",indexGetStartedButton:"indexGetStartedButton_CTr_",indexGitHubButtonWrapper:"indexGitHubButtonWrapper_WSqu",indexGitHubButton:"indexGitHubButton_vvUO"};const m=function(){const e=(0,s.A)(),{siteConfig:t={}}=e;return n.createElement(o.A,{title:"Hello from "+t.title},n.createElement("header",{className:(0,a.A)("hero hero--primary white-bg",l.heroBanner)},n.createElement("div",{className:l.heroInner},n.createElement("img",{className:(0,a.A)("banner-img",l.heroLogo),src:"img/logo.png"}),n.createElement("h1",{className:l.heroProjectTagline},n.createElement("p",{className:"hero__subtitle purple-text"},t.tagline)),n.createElement("div",{className:l.index},n.createElement(i.A,{className:l.indexGetStartedButton,to:(0,c.A)("docs/")},"Get Started"),n.createElement("span",{className:l.indexGitHubButtonWrapper},n.createElement("iframe",{className:l.indexGitHubButton,src:"https://ghbtns.com/github-btn.html?user=reasonml-community&repo=rescript-apollo-client&type=star&count=true&size=large",width:160,height:30,title:"GitHub Stars"}))))))}}}]);
--------------------------------------------------------------------------------
/src/graphql/error/ApolloClient__Graphql_Error_GraphQLError.res:
--------------------------------------------------------------------------------
1 | module Ast = ApolloClient__Graphql_Language_Ast
2 | module Location = ApolloClient__Graphql_Location
3 | module Source = ApolloClient__Graphql_Language_Source.Source
4 |
5 | // export class GraphQLError extends Error {
6 | // constructor(
7 | // message: string,
8 | // nodes?: Maybe{"Loading"->React.string}
27 | | {loading, data: Some({todos}), error} => 28 | <> 29 | 36 |{"Error loading data"->React.string}
39 | }} 40 |
16 | {switch queryResult {
17 | | {loading: true, data: None} =>
56 | }
57 |
--------------------------------------------------------------------------------
/src/@apollo/client/testing/react/ApolloClient__Testing_React_MockedProvider.res:
--------------------------------------------------------------------------------
1 | module InMemoryCache = ApolloClient__Cache_InMemory_InMemoryCache
2 | module ApolloClient = ApolloClient__Core_ApolloClient
3 | module ApolloProvider = ApolloClient__React_Context_ApolloProvider
4 | module Core = ApolloClient__Testing_Core
5 | module Types = ApolloClient__Testing_Types
6 |
7 | // export interface MockedProviderProps{"Loading"->React.string}
18 | | {loading, data: Some({todos}), error, fetchMore} => 19 |
20 |
27 |
53 | | {loading: false, data: None} => 28 | {React.string("There are " ++ (todos->Belt.Array.length->string_of_int ++ " To-Dos"))} 29 |
30 |31 | 51 |
52 |{"Error loading data"->React.string}
54 | }} 55 |{"[ Not functional, but the examples are still valid ]"->React.string}
59 | {switch queryResult { 60 | | {data: Some({todos})} => 61 |62 | {React.string("There are " ++ (todos->Belt.Array.length->string_of_int ++ " To-Dos"))} 63 |
64 | | _ignoredForExample => React.null 65 | }} 66 | 67 | } 68 | -------------------------------------------------------------------------------- /src/ApolloClient__Utils.res: -------------------------------------------------------------------------------- 1 | module ApolloError = ApolloClient__Errors_ApolloError 2 | module Graphql = ApolloClient__Graphql 3 | module Types = ApolloClient__Types 4 | 5 | @new external makeError: string => Js.Exn.t = "Error" 6 | 7 | let ensureError = ApolloError.ensureError 8 | 9 | external asJson: 'any => Js.Json.t = "%identity" 10 | 11 | let safeParse: (. 'jsData => 'data) => Types.safeParse<'data, 'jsData> = (. parse) => 12 | (. jsData) => 13 | switch parse(jsData) { 14 | | data => Ok(data) 15 | | exception Js.Exn.Error(error) => Error({value: jsData->asJson, error}) 16 | } 17 | 18 | let safeParseAndLiftToCommonResultProps: ( 19 | ~jsData: option<'jsData>, 20 | ~graphQLErrors: array
13 | {imgUrl && (
14 |
21 | );
22 | }
23 |
24 | function Home() {
25 | const context = useDocusaurusContext();
26 | const { siteConfig = {} } = context;
27 | return (
28 |
15 | 
16 |
17 | )}
18 |
16 | {title}
19 |{description}
20 |
33 | 
37 |
58 |
37 | 38 |
{siteConfig.tagline}
39 | 40 |
41 |
45 | Get Started
46 |
47 |
48 |
55 |
56 |
57 |
76 |
84 |
--------------------------------------------------------------------------------
/docs/assets/js/935f2afb.b95b99fe.js:
--------------------------------------------------------------------------------
1 | "use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[581],{5610:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docs":[{"type":"category","label":"Getting Started ","items":[{"type":"link","label":"Overview","href":"/rescript-apollo-client/docs/","docId":"overview"},{"type":"link","label":"Installation","href":"/rescript-apollo-client/docs/installation","docId":"installation"},{"type":"link","label":"Create a Client","href":"/rescript-apollo-client/docs/client-configuration","docId":"client-configuration"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Fetching","items":[{"type":"link","label":"Queries","href":"/rescript-apollo-client/docs/queries","docId":"queries"},{"type":"link","label":"Mutations","href":"/rescript-apollo-client/docs/mutations","docId":"mutations"},{"type":"link","label":"Subscriptions","href":"/rescript-apollo-client/docs/subscriptions","docId":"subscriptions"}],"collapsed":true,"collapsible":true}]},"docs":{"changelog":{"id":"changelog","title":"Changelog","description":"Tags:"},"client-configuration":{"id":"client-configuration","title":"Create a Client","description":"Let\'s initialize an ApolloClient instance. You\'ll need to provide it the URL of a running GraphQL server, such as the Star Wars API.","sidebar":"docs"},"contributing":{"id":"contributing","title":"Contributing","description":"Lets work to make the Apollo experience in ReScript the best experience out there!"},"gotchas":{"id":"gotchas","title":"gotchas","description":""},"installation":{"id":"installation","title":"Installation","description":"1. graphql-ppx","sidebar":"docs"},"mutations":{"id":"mutations","title":"Mutations","description":"Using React Hooks","sidebar":"docs"},"overview":{"id":"overview","title":"Overview","description":"This library provides rescript bindings to @apollo/client and related libraries. We rely on the amazing Graphql-ppx for completely typesafe GraphQL operations and fragments in Rescript. This means that even when manipulating the cache directly, you\'ll always be working with rescript data structures and never have to concern yourself the javascript representation of your data!","sidebar":"docs"},"queries":{"id":"queries","title":"Queries","description":"Using React Hooks","sidebar":"docs"},"subscriptions":{"id":"subscriptions","title":"Subscriptions","description":"Using React Hooks","sidebar":"docs"}}}')}}]);
--------------------------------------------------------------------------------
/documentationWebsite/src/pages/styles.module.css:
--------------------------------------------------------------------------------
1 | /* stylelint-disable docusaurus/copyright-header */
2 |
3 | /**
4 | * CSS files with the .module.css suffix will be treated as CSS modules
5 | * and scoped locally.
6 | */
7 |
8 | .section {
9 | padding: 72px 0;
10 | }
11 |
12 | .featureImage {
13 | max-width: 60%;
14 | max-height: 128px;
15 | margin: 0 auto;
16 | }
17 |
18 | .hero {
19 | padding: 48px;
20 | }
21 |
22 | .heroInner {
23 | margin: 0 auto;
24 | max-width: 1100px;
25 | padding: 0 20px;
26 | }
27 |
28 | .heroProjectTagline {
29 | color: black;
30 | font-size: 60px;
31 | text-align: center;
32 | margin: 0;
33 | }
34 |
35 | .heroLogo {
36 | animation-duration: 2s;
37 | animation-name: jackInTheBox;
38 | float: right;
39 | margin-top: 20px;
40 | padding-bottom: 20px;
41 | }
42 |
43 | .index {
44 | display: flex;
45 | align-items: center;
46 | margin-top: 24px;
47 | justify-content: center;
48 | }
49 |
50 | .indexGetStartedButton {
51 | border: 1px solid var(--ifm-color-primary);
52 | display: inline-block;
53 | line-height: 1.2em;
54 | text-decoration: none !important;
55 | text-transform: uppercase;
56 | transition: background 0.3s, color 0.3s;
57 | border-radius: 8px;
58 | border-width: 2px;
59 | color: black;
60 | font-size: 24px;
61 | font-weight: bold;
62 | padding: 18px 36px;
63 | }
64 |
65 | .indexGitHubButtonWrapper {
66 | display: flex;
67 | }
68 |
69 | .indexGitHubButton {
70 | border: none;
71 | margin-left: 24px;
72 | overflow: hidden;
73 | }
74 |
75 | @media only screen and (max-width: 768px) {
76 | .hero {
77 | padding-left: 20px;
78 | padding-right: 20px;
79 | }
80 |
81 | .heroInner {
82 | padding: 0;
83 | }
84 |
85 | .heroProjectTagline {
86 | font-size: 36px;
87 | text-align: center;
88 | }
89 |
90 | .heroLogo {
91 | display: block;
92 | float: none;
93 | margin: 0 auto;
94 | }
95 |
96 | .index {
97 | justify-content: center;
98 | }
99 |
100 | .indexGitHubButton {
101 | display: none;
102 | }
103 | }
104 |
105 | @keyframes jackInTheBox {
106 | from {
107 | opacity: 0;
108 | transform: scale(0.1) rotate(30deg);
109 | transform-origin: center bottom;
110 | }
111 |
112 | 50% {
113 | transform: rotate(-10deg);
114 | }
115 |
116 | 70% {
117 | transform: rotate(3deg);
118 | }
119 |
120 | to {
121 | opacity: 1;
122 | transform: scale(1);
123 | }
124 | }
--------------------------------------------------------------------------------
/docs/assets/js/b2dbe049.067aca93.js:
--------------------------------------------------------------------------------
1 | "use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95],{5680:(e,t,r)=>{r.d(t,{xA:()=>s,yg:()=>m});var n=r(6540);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t77 | 78 |
79 |80 | 81 |
82 |{"[ To-Dos also logged in console with watchQuery ]"->React.string}
83 |
31 | {switch StatsSubscription.use() {
32 | | {data: Some({siteStatisticsUpdated: Some({currentVisitorsOnline})})} =>
33 |
39 | ```
40 |
41 | ### Subscribing to Updates for a Query
42 |
43 | Whenever a query returns a result in Apollo Client, that result includes a subscribeToMore function. You can use this function to execute a followup subscription that pushes updates to the query's original result.
44 |
45 | > The `subscribeToMore `function is similar in structure to the `fetchMore` function that's commonly used for handling pagination. The primary difference is that `fetchMore` executes a followup query, whereas `subscribeToMore` executes a subscription.
46 |
47 | The following example is totally nonsensical for reasons I won't go into, but should give you an idea of how to go about it.
48 |
49 | ```reason
50 | @react.component
51 | let make = () => {
52 | let queryResult = TodosQuery.use()
53 |
54 | React.useEffect0(() => {
55 | queryResult.subscribeToMore(
56 | ~subscription=module(StatsSubscription),
57 | ~updateQuery=(previous, {subscriptionData: {data: {siteStatisticsUpdated}}}) => {
58 | {
59 | todos: Belt.Array.concat(
60 | previous.todos,
61 | [
62 | {
63 | __typename: "TodoItem",
64 | id: "subscribeToMoreTodo",
65 | completed: None,
66 | text: "Check how many visitors are online!"),
67 | },
68 | ],
69 | ),
70 | }
71 | },
72 | (),
73 | )
74 | None
75 | })
76 |
77 | switch queryResult {
78 | | {data: Some({todos})} =>
79 | // render something
80 | }
81 | }
82 | ```
83 |
84 | ## Directly Via the Apollo Client
85 |
86 | ```reason
87 | let statsSubscription = Apollo.client.subscribe(
88 | ~subscription=module(StatsSubscription),
89 | (),
90 | ).subscribe(
91 | ~onNext=value => Js.log2("new value:", value),
92 | ~onError=error => Js.log2("subscription error:", error),
93 | (),
94 | )
95 | // Unsubscribe like so:
96 | // statsSubscription.unsubscribe()
97 | ```
98 |
--------------------------------------------------------------------------------
/src/graphql-ws/ApolloClient__GraphqlWs_Common.res:
--------------------------------------------------------------------------------
1 | module MessageType = {
2 | module Js_ = {
3 | // /**
4 | // * Types of messages allowed to be sent by the client/server over the WS protocol.
5 | // *
6 | // * @category Common
7 | // */
8 | // export enum MessageType {
9 | // ConnectionInit = 'connection_init', // Client -> Server
10 | // ConnectionAck = 'connection_ack', // Server -> Client
11 |
12 | // Ping = 'ping', // bidirectional
13 | // Pong = 'pong', /// bidirectional
14 |
15 | // Subscribe = 'subscribe', // Client -> Server
16 | // Next = 'next', // Server -> Client
17 | // Error = 'error', // Server -> Client
18 | // Complete = 'complete', // bidirectional
19 | // }
20 | type t = string
21 | }
22 |
23 | type t =
24 | ConnectionInit | ConnectionAck | Ping | Pong | Subscribe | Next | Error | Complete | Unknown
25 |
26 | let fromJs: Js_.t => t = js =>
27 | switch js {
28 | | "connection_init" => ConnectionInit
29 | | "connection_ack" => ConnectionAck
30 |
31 | | "ping" => Ping
32 | | "pong" => Pong
33 |
34 | | "subscribe" => Subscribe
35 | | "next" => Next
36 | | "error" => Error
37 | | "complete" => Complete
38 | | _ => Unknown
39 | }
40 | }
41 |
42 | module Message = {
43 | module Js_ = {
44 | // export type Message34 | {React.string("There are " ++ (string_of_int(currentVisitorsOnline) ++ " visitors online"))} 35 |
36 | | _ignoredForExample => React.null 37 | }} 38 |
30 |
32 | My first Apollo app 🚀
31 |{React.string("To-Do added: \"" ++ (text ++ "\""))}
93 | | {error} => 94 | <> 95 | {"Error loading data"->React.string} 96 | {switch error { 97 | | Some(error) => React.string(": " ++ error.message) 98 | | None => React.null 99 | }} 100 | 101 | } 102 | } 103 | -------------------------------------------------------------------------------- /src/@apollo/client/cache/inmemory/ApolloClient__Cache_InMemory_InMemoryCache.res: -------------------------------------------------------------------------------- 1 | module ApolloCache = ApolloClient__Cache_Core_Cache.ApolloCache 2 | module KeyFieldsFunction = ApolloClient__Cache_InMemory_Policies.KeyFieldsFunction 3 | module PossibleTypesMap = ApolloClient__Cache_InMemory_Policies.PossibleTypesMap 4 | module TypePolicy = ApolloClient__Cache_InMemory_Policies.TypePolicy 5 | module TypePolicies = ApolloClient__Cache_InMemory_Policies.TypePolicies 6 | 7 | module InMemoryCacheConfig = { 8 | module Js_ = { 9 | // export interface InMemoryCacheConfig extends ApolloReducerConfig { 10 | // resultCaching?: boolean; 11 | // possibleTypes?: PossibleTypesMap; 12 | // typePolicies?: TypePolicies; 13 | // } 14 | type t = { 15 | resultCaching?: bool, 16 | possibleTypes?: PossibleTypesMap.Js_.t, 17 | typePolicies?: TypePolicies.Js_.t, 18 | // ...extends ApolloReducerConfig 19 | dataIdFromObject?: KeyFieldsFunction.Js_.t, 20 | addTypename?: bool, 21 | } 22 | } 23 | type t = Js_.t 24 | } 25 | 26 | module Js_ = { 27 | // export declare class InMemoryCache extends ApolloCache{React.string("To-Do added: \"" ++ (text ++ "\""))}
108 | | {error} => <> 109 | {"Error loading data"->React.string} 110 | {switch error { 111 | | Some(error) => React.string(": " ++ error.message) 112 | | None => React.null 113 | }} 114 | 115 | } 116 | } 117 | ``` 118 | 119 | ## Directly Via the Apollo Client 120 | 121 | ```reason 122 | let addTodo = _ => 123 | // This assumes you've set up a Client module as in the Getting Started section 124 | Apollo.client.mutate(~mutation=module(AddTodoMutation), {text: "Another To-Do"}) 125 | ->Promise.map(result => 126 | switch result { 127 | | Ok({data}) => Js.log2("mutate result: ", data) 128 | | Error(error) => Js.log2("Error: ", error) 129 | } 130 | ) 131 | ->ignore 132 | ``` 133 | -------------------------------------------------------------------------------- /src/zen-observable/ApolloClient__ZenObservable.res: -------------------------------------------------------------------------------- 1 | // interface SubscriptionObserver
12 |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/src/@apollo/client/link/error/ApolloClient__Link_Error.res:
--------------------------------------------------------------------------------
1 | module ApolloLink = ApolloClient__Link_Core_ApolloLink
2 | module ApolloError = ApolloClient__Errors_ApolloError
3 | module GraphQLError = ApolloClient__Graphql.Error.GraphQLError
4 | module ExecutionResult = ApolloClient__Graphql_Execution_Execute.ExecutionResult
5 | module FetchResult = ApolloClient__Link_Core_Types.FetchResult
6 | module NextLink = ApolloClient__Link_Core_Types.NextLink
7 | module Observable = ApolloClient__ZenObservable.Observable
8 | module Operation = ApolloClient__Link_Core_Types.Operation
9 | module ServerError = ApolloClient__Link_Utils_ThrowServerError.ServerError
10 | module ServerParseError = ApolloClient__Link_Http_ParseAndCheckHttpResponse.ServerParseError
11 |
12 | // export declare class ErrorLink extends ApolloLink {
13 | // private link;
14 | // constructor(errorHandler: ErrorLink.ErrorHandler);
15 | // request(operation: Operation, forward: NextLink): Observable
37 | {"There are "->React.string} {todos->Belt.Array.length->React.int} {" To-Dos"->React.string}
38 |
39 | | {data: None, error: None, loading: false} =>
40 | "You might think this is impossible, but depending on the situation it might not be!"->React.string
41 | }
42 | ```
43 |
44 | ### Typical Usage
45 |
46 | While we wish it was always as easy as above, there are many situations where you may be fetching new data while rendering a cached results, etc. Here's a slightly more complex example:
47 |
48 | ```reason
49 | @react.component
50 | let make = () => {
51 | let queryResult = TodosQuery.use()
52 |
53 |
54 | {switch queryResult {
55 | | {loading: true, data: None} =>
77 | }
78 | ```
79 |
80 | ### Lazy Fetching of Data
81 |
82 | ```reason
83 | @react.component
84 | let make = () => {
85 | let (executeQuery, queryResult) = TodosQuery.useLazy()
86 | {"Loading"->React.string}
56 | | {loading, data: Some({todos}), error, fetchMore} => 57 |
58 |
65 |
74 | | {loading: false, data: None} => 66 | {React.string("There are " ++ (todos->Belt.Array.length->string_of_int ++ " To-Dos"))} 67 |
68 |69 | 72 |
73 |{"Error loading data"->React.string}
75 | }} 76 |
87 | {switch queryResult {
88 | | Unexecuted(_) => <>
89 | {"Waiting to be executed... "->React.string}
90 |
91 |
92 | | Executed({loading: true, data: None}) =>
108 | }
109 | ```
110 |
111 | ### Live Queries
112 |
113 | It's possible to update a query by attaching a subscription. Please see the subscriptions section on how to do this.
114 |
115 | ## Directly Via the Apollo Client
116 |
117 | There are many instances where you might want to query outside the context of React. You can use the `query` method directly on the client to do this.
118 |
119 | ```reason
120 | let addTodo = _ =>
121 | // This assumes you've set up a Client module as in the Getting Started section
122 | Apollo.client.mutate(~mutation=module(AddTodoMutation), {text: "Another To-Do"})
123 | ->Promise.map(result =>
124 | switch result {
125 | | Ok({data}) => Js.log2("mutate result: ", data)
126 | | Error(error) => Js.log2("Error: ", error)
127 | },
128 | )
129 | ->ignore
130 | ```
131 |
132 | If you need to react to changes in some data in the cache, not just a one-off fetch, you can use the `watchQuery` method.
133 |
134 | ```reason
135 | // This assumes you've set up a Client module as in the Getting Started section
136 | let observableQuery = Apollo.client.watchQuery(~query=module(TodosQuery), ())
137 |
138 | let watchQuerySubscription = observableQuery.subscribe(~onNext=result =>
139 | switch result {
140 | | {data: Some({todos})} => Js.log2("watchQuery To-Dos: ", todos)
141 | | _ => ()
142 | }
143 | , ())
144 |
145 | // Unsubscribe like so:
146 | // watchQuerySubscription.unsubscribe();
147 | ```
148 |
--------------------------------------------------------------------------------
/src/@apollo/client/cache/inmemory/ApolloClient__Cache_InMemory_Policies.res:
--------------------------------------------------------------------------------
1 | module FragmentMap = ApolloClient__Utilities_Graphql_Fragments.FragmentMap
2 | module FieldPolicy = ApolloClient__Cache_InMemory_Policies_FieldPolicy.FieldPolicy
3 | module FieldReadFunction = ApolloClient__Cache_InMemory_Policies_FieldPolicy.FieldReadFunction
4 | module FieldMergeFunction = ApolloClient__Cache_InMemory_Policies_FieldPolicy.FieldMergeFunction
5 | module KeyArgs = ApolloClient__Cache_InMemory_Policies_FieldPolicy.FieldPolicy_KeyArgs
6 | module KeySpecifier = ApolloClient__Cache_InMemory_Policies_FieldPolicy.KeySpecifier
7 | module Pagination = ApolloClient__Utilities_Policies_Pagination
8 | module SelectionSetNode = ApolloClient__Graphql.Language.Ast.SelectionSetNode
9 |
10 | module KeyFieldsContext = {
11 | type t = {
12 | typename?: string,
13 | selectionSet?: SelectionSetNode.t,
14 | fragment?: FragmentMap.t,
15 | keyObject?: Js.Json.t,
16 | }
17 | }
18 |
19 | module KeyFieldsFunction = {
20 | type t = (Js.Json.t, KeyFieldsContext.t) => string
21 | module Js_ = {
22 | // export declare type KeyFieldsFunction = (object: Readonly{"Loading"->React.string}
93 | | Executed({loading, data: Some({todos}), error}) => <> 94 | 101 |102 | {React.string("There are " ++ (todos->Belt.Array.length->string_of_int ++ " To-Dos"))} 103 |
104 | 105 | | Executed({loading: false, data: None}) =>{"Error loading data"->React.string}
106 | }} 107 |
12 |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, religion, or sexual identity
10 | and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | - Demonstrating empathy and kindness toward other people
21 | - Being respectful of differing opinions, viewpoints, and experiences
22 | - Giving and gracefully accepting constructive feedback
23 | - Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | - Focusing on what is best not just for us as individuals, but for the
26 | overall community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | - The use of sexualized language or imagery, and sexual attention or
31 | advances of any kind
32 | - Trolling, insulting or derogatory comments, and personal or political attacks
33 | - Public or private harassment
34 | - Publishing others' private information, such as a physical or email
35 | address, without their explicit permission
36 | - Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official e-mail address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | jeddeloh@gmail.com.
64 | All complaints will be reviewed and investigated promptly and fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series
86 | of actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or
93 | permanent ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 |
115 | ## Attribution
116 |
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.0, available at
119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 |
121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 | enforcement ladder](https://github.com/mozilla/diversity).
123 |
124 | [homepage]: https://www.contributor-covenant.org
125 |
126 | For answers to common questions about this code of conduct, see the FAQ at
127 | https://www.contributor-covenant.org/faq. Translations are available at
128 | https://www.contributor-covenant.org/translations.
129 |
--------------------------------------------------------------------------------
/docs/assets/js/3b8c55ea.6167ef36.js:
--------------------------------------------------------------------------------
1 | "use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[803],{5680:(e,n,t)=>{t.d(n,{xA:()=>s,yg:()=>m});var l=t(6540);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);n&&(l=l.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,l)}return t}function a(e){for(var n=1;ngraphql-ppx",id:"1-graphql-ppx",level:3},{value:"2. Apollo Client",id:"2-apollo-client",level:3},{value:"3. Apollo-Specific graphql-ppx Configuration",id:"3-apollo-specific-graphql-ppx-configuration",level:3}],d={toc:u},g="wrapper";function m(e){let{components:n}=e,t=(0,o.A)(e,a);return(0,r.yg)(g,(0,l.A)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,r.yg)("h3",{id:"1-graphql-ppx"},"1. ",(0,r.yg)("inlineCode",{parentName:"h3"},"graphql-ppx")),(0,r.yg)("p",null,"We rely on Graphql-ppx for typesafe GraphQL operations and fragments in ReasonML. ",(0,r.yg)("a",{parentName:"p",href:"https://beta.graphql-ppx.com"},"Go to the official documentation")," for installation instructions."),(0,r.yg)("p",null,"You should now have a ",(0,r.yg)("inlineCode",{parentName:"p"},"graphql_schema.json")," in your project somewhere. Make sure it's always up-to-date!"),(0,r.yg)("h3",{id:"2-apollo-client"},"2. Apollo Client"),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre",className:"language-sh"},"npm install rescript-apollo-client @apollo/client\n")),(0,r.yg)("h3",{id:"3-apollo-specific-graphql-ppx-configuration"},"3. Apollo-Specific ",(0,r.yg)("inlineCode",{parentName:"h3"},"graphql-ppx")," Configuration"),(0,r.yg)("p",null,"Add the following under ",(0,r.yg)("inlineCode",{parentName:"p"},"bs-dependencies")," and ",(0,r.yg)("inlineCode",{parentName:"p"},"graphql"),", in your ",(0,r.yg)("inlineCode",{parentName:"p"},"bsconfig.json")),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre",className:"language-diff"},'{\n "graphql": {\n+ "apolloMode": true,\n+ "extendMutation": "ApolloClient.GraphQL_PPX.ExtendMutation",\n+ "extendQuery": "ApolloClient.GraphQL_PPX.ExtendQuery",\n+ "extendSubscription": "ApolloClient.GraphQL_PPX.ExtendSubscription",\n+ "templateTagReturnType": "ApolloClient.GraphQL_PPX.templateTagReturnType",\n+ "templateTagImport": "gql",\n+ "templateTagLocation": "@apollo/client"\n },\n "ppx-flags": ["@reasonml-community/graphql-ppx/ppx"],\n "bs-dependencies: [\n "@reasonml-community/graphql-ppx"\n+ "rescript-apollo-client"\n ]\n}\n')),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},'"apolloMode"')," automaticaly sprinkles ",(0,r.yg)("inlineCode",{parentName:"li"},"__typename")," throughout our operation and fragment definitions"),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},'"templateTag*"')," is how we tell ",(0,r.yg)("inlineCode",{parentName:"li"},"graphql-ppx")," to wrap every operation with ",(0,r.yg)("inlineCode",{parentName:"li"},"gql")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},'"extend*"')," allows ",(0,r.yg)("inlineCode",{parentName:"li"},"rescript-apollo-client")," to automatically decorate the generated modules with Apollo-specific things like the correct hook for that operation!")))}m.isMDXComponent=!0}}]);
--------------------------------------------------------------------------------
/src/@apollo/client/react/hooks/ApolloClient__React_Hooks_UseLazyQuery.res:
--------------------------------------------------------------------------------
1 | module ApolloClient = ApolloClient__Core_ApolloClient
2 | module ApolloError = ApolloClient__Errors_ApolloError
3 | module ErrorPolicy = ApolloClient__Core_WatchQueryOptions.ErrorPolicy
4 | module Graphql = ApolloClient__Graphql
5 | module LazyQueryHookOptions = ApolloClient__React_Types.LazyQueryHookOptions
6 | module QueryTuple = ApolloClient__React_Types.QueryTuple
7 | module QueryTuple__noVariables = ApolloClient__React_Types.QueryTuple__noVariables
8 | module Types = ApolloClient__Types
9 | module Utils = ApolloClient__Utils
10 | module WatchQueryFetchPolicy = ApolloClient__Core_WatchQueryOptions.WatchQueryFetchPolicy
11 |
12 | module type Operation = Types.Operation
13 | module type OperationNoRequiredVars = Types.OperationNoRequiredVars
14 |
15 | module Js_ = {
16 | // export declare function useLazyQuery
12 |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/src/@apollo/client/link/core/ApolloClient__Link_Core_Types.res:
--------------------------------------------------------------------------------
1 | module ApolloError = ApolloClient__Errors_ApolloError
2 | module Graphql = ApolloClient__Graphql
3 | module GraphQLError = ApolloClient__Graphql.Error.GraphQLError
4 | module Observable = ApolloClient__ZenObservable.Observable
5 | module Types = ApolloClient__Types
6 | module Utils = ApolloClient__Utils
7 |
8 | module GraphQLRequest = {
9 | module Js_ = {
10 | // export interface GraphQLRequest {
11 | // query: DocumentNode;
12 | // variables?: RecordChangelog
Tags:
- 🚀 - New Feature
- 💥 - Breaking Change
- 🐛 - Bug Fix
12 |