graphiti 2.0.0.beta.7 → 2.0.0.beta.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (251) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +56 -4
  4. data/.github/workflows/docs.yml +10 -7
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.github/workflows/release.yml +1 -1
  7. data/.gitignore +2 -0
  8. data/.standard.yml +6 -0
  9. data/CHANGELOG.md +66 -0
  10. data/CONTRIBUTING.md +3 -1
  11. data/README.md +13 -206
  12. data/Rakefile +34 -3
  13. data/UPGRADING.md +2 -2
  14. data/graphiti.gemspec +8 -4
  15. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  16. data/lib/generators/graphiti/install_generator.rb +1 -1
  17. data/lib/generators/graphiti/resource_generator.rb +6 -3
  18. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  19. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  20. data/lib/graphiti/audit/report.rb +6 -6
  21. data/lib/graphiti/audit.rb +3 -4
  22. data/lib/graphiti/configuration.rb +11 -4
  23. data/lib/graphiti/debugger.rb +18 -6
  24. data/lib/graphiti/delegates/pagination.rb +2 -2
  25. data/lib/graphiti/deserializer.rb +3 -3
  26. data/lib/graphiti/error_serializers/deprecated_constants.rb +23 -0
  27. data/lib/graphiti/error_serializers/invalid_request.rb +6 -0
  28. data/lib/graphiti/errors.rb +22 -6
  29. data/lib/graphiti/extensions/temp_id.rb +1 -1
  30. data/lib/graphiti/query.rb +5 -4
  31. data/lib/graphiti/rails/context.rb +2 -1
  32. data/lib/graphiti/rails/controller.rb +3 -0
  33. data/lib/graphiti/rails/debugging.rb +1 -1
  34. data/lib/graphiti/rails/responders.rb +2 -1
  35. data/lib/graphiti/rails.rb +14 -0
  36. data/lib/graphiti/railtie.rb +8 -0
  37. data/lib/graphiti/resource/configuration.rb +1 -0
  38. data/lib/graphiti/resource/dsl.rb +2 -2
  39. data/lib/graphiti/resource/links.rb +1 -1
  40. data/lib/graphiti/resource/persistence.rb +1 -1
  41. data/lib/graphiti/resource/polymorphism.rb +1 -1
  42. data/lib/graphiti/resource.rb +2 -2
  43. data/lib/graphiti/resource_proxy.rb +0 -1
  44. data/lib/graphiti/scope.rb +68 -21
  45. data/lib/graphiti/scoping/filter.rb +5 -3
  46. data/lib/graphiti/scoping/paginate.rb +1 -1
  47. data/lib/graphiti/scoping/sort.rb +1 -1
  48. data/lib/graphiti/sideload/has_many.rb +1 -1
  49. data/lib/graphiti/sideload/polymorphic_belongs_to.rb +11 -4
  50. data/lib/graphiti/sideload.rb +8 -6
  51. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  52. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  53. data/lib/graphiti/types.rb +5 -1
  54. data/lib/graphiti/util/cache_debug.rb +3 -3
  55. data/lib/graphiti/util/hash.rb +1 -1
  56. data/lib/graphiti/util/persistence.rb +6 -6
  57. data/lib/graphiti/util/serializer_relationships.rb +11 -2
  58. data/lib/graphiti/version.rb +1 -1
  59. data/lib/graphiti.rb +1 -1
  60. data/lib/tasks/graphiti.rake +1 -1
  61. data/package-lock.json +114 -0
  62. data/package.json +16 -3
  63. metadata +33 -198
  64. data/docs/concepts/backends-and-models.md +0 -122
  65. data/docs/concepts/endpoints.md +0 -183
  66. data/docs/concepts/links.md +0 -212
  67. data/docs/concepts/overview.md +0 -80
  68. data/docs/concepts/persisting.md +0 -376
  69. data/docs/concepts/relationships.md +0 -627
  70. data/docs/concepts/resources.md +0 -677
  71. data/docs/getting-started/first-api.md +0 -289
  72. data/docs/getting-started/installation.md +0 -185
  73. data/docs/intro.md +0 -307
  74. data/docs/js/authentication.md +0 -63
  75. data/docs/js/ddau.md +0 -20
  76. data/docs/js/extra-params.md +0 -41
  77. data/docs/js/index.md +0 -112
  78. data/docs/js/installation.md +0 -120
  79. data/docs/js/middleware.md +0 -72
  80. data/docs/js/models.md +0 -202
  81. data/docs/js/reads.md +0 -494
  82. data/docs/js/state-syncing.md +0 -100
  83. data/docs/js/writes.md +0 -373
  84. data/docs/reference/vandal.md +0 -63
  85. data/docs/reference/why.md +0 -13
  86. data/docs/topics/authorization.md +0 -155
  87. data/docs/topics/caching.md +0 -55
  88. data/docs/topics/customizing-sideloads.md +0 -156
  89. data/docs/topics/debugging.md +0 -242
  90. data/docs/topics/error-handling.md +0 -210
  91. data/docs/topics/etags.md +0 -46
  92. data/docs/topics/hopping-relationships.md +0 -149
  93. data/docs/topics/json-attributes.md +0 -77
  94. data/docs/topics/openstruct-models.md +0 -50
  95. data/docs/topics/remote-resources.md +0 -291
  96. data/docs/topics/testing.md +0 -916
  97. data/docs/topics/without-activerecord.md +0 -324
  98. data/docs/tutorial/index.md +0 -58
  99. data/docs/tutorial/step_0.md +0 -107
  100. data/docs/tutorial/step_1.md +0 -199
  101. data/docs/tutorial/step_2.md +0 -312
  102. data/docs/tutorial/step_3.md +0 -142
  103. data/docs/tutorial/step_4.md +0 -135
  104. data/docs/tutorial/step_5.md +0 -69
  105. data/docs/tutorial/step_6.md +0 -82
  106. data/docs/tutorial/step_7.md +0 -205
  107. data/docs/tutorial/step_8.md +0 -128
  108. data/docs/tutorial/step_9.md +0 -171
  109. data/docs/upgrading.md +0 -267
  110. data/website/.gitignore +0 -20
  111. data/website/README.md +0 -43
  112. data/website/docusaurus.config.js +0 -197
  113. data/website/package-lock.json +0 -19474
  114. data/website/package.json +0 -46
  115. data/website/sidebars.js +0 -82
  116. data/website/src/css/custom.css +0 -85
  117. data/website/src/pages/markdown-page.mdx +0 -7
  118. data/website/static/.nojekyll +0 -0
  119. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  120. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  121. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  122. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  123. data/website/static/1.13/CNAME +0 -1
  124. data/website/static/1.13/README.md +0 -16
  125. data/website/static/1.13/assets/css/syntax.css +0 -60
  126. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  127. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  128. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  129. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  130. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  131. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  132. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  133. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  134. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  135. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  136. data/website/static/1.13/assets/img/backend.gif +0 -0
  137. data/website/static/1.13/assets/img/conformity.png +0 -0
  138. data/website/static/1.13/assets/img/error_payload.png +0 -0
  139. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  140. data/website/static/1.13/assets/img/gh.png +0 -0
  141. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  142. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  143. data/website/static/1.13/assets/img/logo-500.png +0 -0
  144. data/website/static/1.13/assets/img/logo.png +0 -0
  145. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  146. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  147. data/website/static/1.13/assets/img/persist.jpg +0 -0
  148. data/website/static/1.13/assets/img/resource.gif +0 -0
  149. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  150. data/website/static/1.13/assets/img/rest1.gif +0 -0
  151. data/website/static/1.13/assets/img/rest2.gif +0 -0
  152. data/website/static/1.13/assets/img/rest3.gif +0 -0
  153. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  154. data/website/static/1.13/assets/img/sunrise.png +0 -0
  155. data/website/static/1.13/assets/img/why.png +0 -0
  156. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  157. data/website/static/1.13/assets/main.css +0 -15518
  158. data/website/static/1.13/assets/main.css.map +0 -1
  159. data/website/static/1.13/bin/bundle +0 -109
  160. data/website/static/1.13/bin/jekyll +0 -27
  161. data/website/static/1.13/bin/kramdown +0 -27
  162. data/website/static/1.13/bin/listen +0 -27
  163. data/website/static/1.13/bin/rake +0 -27
  164. data/website/static/1.13/bin/rougify +0 -27
  165. data/website/static/1.13/bin/safe_yaml +0 -27
  166. data/website/static/1.13/bin/sass +0 -27
  167. data/website/static/1.13/bin/sass-convert +0 -27
  168. data/website/static/1.13/bin/scss +0 -27
  169. data/website/static/1.13/blog.html +0 -259
  170. data/website/static/1.13/cheatsheet.html +0 -316
  171. data/website/static/1.13/cookbooks/authorization.md +0 -0
  172. data/website/static/1.13/cookbooks/caching.md +0 -0
  173. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  174. data/website/static/1.13/cookbooks/etags.md +0 -0
  175. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  176. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  177. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  178. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  179. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  180. data/website/static/1.13/features.html +0 -249
  181. data/website/static/1.13/feed.xml +0 -106
  182. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  183. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  184. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  185. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  186. data/website/static/1.13/guides/concepts/links.html +0 -501
  187. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  188. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  189. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  190. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  191. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  192. data/website/static/1.13/guides/index.html +0 -269
  193. data/website/static/1.13/guides/overview.html +0 -325
  194. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  195. data/website/static/1.13/guides/upgrading.html +0 -314
  196. data/website/static/1.13/guides/vandal.html +0 -282
  197. data/website/static/1.13/guides/why.html +0 -1121
  198. data/website/static/1.13/index.html +0 -72
  199. data/website/static/1.13/js/authentication.html +0 -295
  200. data/website/static/1.13/js/ddau.html +0 -238
  201. data/website/static/1.13/js/extra-params.html +0 -270
  202. data/website/static/1.13/js/index.html +0 -321
  203. data/website/static/1.13/js/installation.html +0 -637
  204. data/website/static/1.13/js/introduction.html +0 -257
  205. data/website/static/1.13/js/middleware.html +0 -318
  206. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  207. data/website/static/1.13/js/reads/filtering.html +0 -289
  208. data/website/static/1.13/js/reads/includes.html +0 -260
  209. data/website/static/1.13/js/reads/index.html +0 -497
  210. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  211. data/website/static/1.13/js/reads/pagination.html +0 -260
  212. data/website/static/1.13/js/reads/sorting.html +0 -265
  213. data/website/static/1.13/js/reads/statistics.html +0 -289
  214. data/website/static/1.13/js/state-syncing.html +0 -340
  215. data/website/static/1.13/js/writes/deferred.html +0 -296
  216. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  217. data/website/static/1.13/js/writes/index.html +0 -391
  218. data/website/static/1.13/js/writes/nested.html +0 -330
  219. data/website/static/1.13/js/writes/validations.html +0 -272
  220. data/website/static/1.13/quickstart.html +0 -660
  221. data/website/static/1.13/template +0 -161
  222. data/website/static/1.13/tutorial/index.html +0 -250
  223. data/website/static/1.13/tutorial/step_0.html +0 -292
  224. data/website/static/1.13/tutorial/step_1.html +0 -517
  225. data/website/static/1.13/tutorial/step_2.html +0 -481
  226. data/website/static/1.13/tutorial/step_3.html +0 -323
  227. data/website/static/1.13/tutorial/step_4.html +0 -318
  228. data/website/static/1.13/tutorial/step_5.html +0 -265
  229. data/website/static/1.13/tutorial/step_6.html +0 -276
  230. data/website/static/1.13/tutorial/step_7.html +0 -390
  231. data/website/static/1.13/tutorial/step_8.html +0 -316
  232. data/website/static/1.13/tutorial/step_9.html +0 -365
  233. data/website/static/CNAME +0 -1
  234. data/website/static/assets/img/error_payload.png +0 -0
  235. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  236. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  237. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  238. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  239. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  240. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  241. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  242. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  243. data/website/static/assets/img/meta_total_count.png +0 -0
  244. data/website/static/img/docusaurus-social-card.jpg +0 -0
  245. data/website/static/img/docusaurus.png +0 -0
  246. data/website/static/img/favicon.ico +0 -0
  247. data/website/static/img/logo.png +0 -0
  248. data/website/static/img/logo.svg +0 -1
  249. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  250. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  251. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/js/reads/fieldsets.html DELETED
@@ -1,271 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
- <meta charset="utf-8">
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
9
- <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
10
-
11
- <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
12
- <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
13
- <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
14
- <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
15
- <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
16
- <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
17
- <meta name="msapplication-TileColor" content="#F86DA7">
18
- <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
19
- <meta name="theme-color" content="#F86DA7">
20
-
21
- <title>Graphiti</title>
22
- <meta name="description" content="Stylish Graph APIs">
23
-
24
- <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
25
- <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
26
-
27
- <!-- Global site tag (gtag.js) - Google Analytics -->
28
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
29
- <script>
30
- window.dataLayer = window.dataLayer || [];
31
- function gtag(){dataLayer.push(arguments);}
32
- gtag('js', new Date());
33
-
34
- gtag('config', 'UA-127904727-1');
35
- </script>
36
-
37
- <!-- javascript -->
38
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
39
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
40
-
41
-
42
- </head>
43
-
44
-
45
- <body>
46
- <main class="page-content" aria-label="Content">
47
- <div class="wrapper">
48
- <header class="navbar navbar-inverse normal" role="banner">
49
- <div class="container">
50
- <div class="navbar-header">
51
- <a href="/1.13/1.13" class="navbar-brand">
52
- <img alt="logo" src="/1.13/assets/img/logo.png">
53
- </a>
54
- </div>
55
- <nav class="" role="navigation">
56
- <ul class="nav navbar-nav nav-links">
57
- <li>
58
- <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
59
- </li>
60
- <li>
61
- <a class="guides nav-link" href="/1.13/guides">Guides</a>
62
- </li>
63
- <li>
64
- <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
65
- </li>
66
- <li>
67
- <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
68
- </li>
69
- </ul>
70
- <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
71
- <li>
72
- <span class="star">⭐</span>
73
- <a href="https://github.com/graphiti-api/graphiti">
74
- <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
75
- </a>
76
- </li>
77
- </ul>
78
- </nav>
79
- </div>
80
- </header>
81
-
82
- <div class="container">
83
- <h1>
84
- Spraypaint
85
- <small>the isomorphic, framework-agnostic Graphiti ORM</small>
86
- </h1>
87
-
88
- <div class="js-toc col-md-3">
89
- <ul>
90
- <li><a href="/1.13/js/index">Home</a></li>
91
- <li><a href="/1.13/js/introduction">Introduction</a></li>
92
- <li><a href="/1.13/js/installation">Installation</a>
93
- <ul>
94
- <li><a href="/1.13/js/installation#typescript">Typescript</a></li>
95
- <li><a href="/1.13/js/installation#defining-models">Defining Models</a></li>
96
- <li><a href="/1.13/js/installation#connecting-to-the-api">Connecting to the API</a></li>
97
- <li><a href="/1.13/js/installation#defining-attributes">Defining Attributes</a></li>
98
- <li><a href="/1.13/js/installation#defining-relationships">Defining Relationships</a></li>
99
- </ul>
100
- </li>
101
- <li><a href="/1.13/js/reads">Reads</a>
102
- <ul>
103
- <li><a href="/1.13/js/reads/sorting">Sorting</a></li>
104
- <li><a href="/1.13/js/reads/pagination">Pagination</a></li>
105
- <li><a href="/1.13/js/reads/filtering">Filtering</a></li>
106
- <li><a href="/1.13/js/reads/fieldsets">Fieldsets</a></li>
107
- <li><a href="/1.13/js/reads/statistics">Statistics</a></li>
108
- <li><a href="/1.13/js/reads/includes">Includes</a></li>
109
- <li><a href="/1.13/js/reads/nested-queries">Nested Queries</a></li>
110
- </ul>
111
- </li>
112
- <li><a href="/1.13/js/writes">Writes</a>
113
- <ul>
114
- <li><a href="/1.13/js/writes/validations">Validations</a></li>
115
- <li><a href="/1.13/js/writes/dirty-tracking">Dirty Tracking</a></li>
116
- <li><a href="/1.13/js/writes/nested">Nested Writes</a></li>
117
- <li><a href="/1.13/js/writes/deferred">Deferred Action</a></li>
118
- </ul>
119
- </li>
120
- <li><a href="/1.13/js/middleware">Middleware</a></li>
121
- <li><a href="/1.13/js/authentication">Authentication</a></li>
122
- <li><a href="/1.13/js/state-syncing">State Syncing</a></li>
123
- <li><a href="/1.13/js/ddau">Data Down, Actions Up</a></li>
124
- <li><a href="/1.13/js/extra-params">Extra params</a></li>
125
- </ul>
126
- </div>
127
-
128
- <div class="col-md-8 col-md-offset-1">
129
- <h3 id="sparse-fieldsets">Sparse Fieldsets</h3>
130
-
131
- <p>Use <code class="language-plaintext highlighter-rouge">#select()</code> to limit the fields returned by the server:</p>
132
-
133
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="nx">Post</span><span class="p">.</span><span class="nf">select</span><span class="p">([</span><span class="dl">'</span><span class="s1">title</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">status</span><span class="dl">'</span><span class="p">]).</span><span class="nf">all</span><span class="p">()</span></code></pre></figure>
134
-
135
- <blockquote class="url">
136
- <p>/posts?fields[posts]=title,status</p>
137
- </blockquote>
138
-
139
- <p>When dealing with relationships, it may be easier to pass an object,
140
- where the key is the corresponding JSONAPI type. This will be exactly
141
- what’s sent to the server in <code class="language-plaintext highlighter-rouge">?fields</code>:</p>
142
-
143
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="nx">Post</span><span class="p">.</span><span class="nf">select</span><span class="p">({</span>
144
- <span class="na">posts</span><span class="p">:</span> <span class="p">[</span><span class="dl">'</span><span class="s1">title</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">status</span><span class="dl">'</span><span class="p">],</span>
145
- <span class="na">comments</span><span class="p">:</span> <span class="p">[</span><span class="dl">'</span><span class="s1">created_at</span><span class="dl">'</span><span class="p">]</span>
146
- <span class="p">}).</span><span class="nf">all</span><span class="p">()</span></code></pre></figure>
147
-
148
- <blockquote class="url">
149
- <p>/posts?fields[posts]=title,status&amp;fields[comments]=created_at</p>
150
- </blockquote>
151
-
152
- <h3 id="extra-fieldsets">Extra Fieldsets</h3>
153
-
154
- <p>Use <code class="language-plaintext highlighter-rouge">#selectExtra()</code> to explicitly request a field that doesn’t usually
155
- come back (often computationally expensive):</p>
156
-
157
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="nx">Post</span><span class="p">.</span><span class="nf">selectExtra</span><span class="p">([</span><span class="dl">'</span><span class="s1">highlights</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">cumulative_ranking</span><span class="dl">'</span><span class="p">]).</span><span class="nf">all</span><span class="p">()</span></code></pre></figure>
158
-
159
- <blockquote class="url">
160
- <p>/posts?extra_fields[posts]=highlights,cumulative_ranking</p>
161
- </blockquote>
162
-
163
- <p>Just like the <code class="language-plaintext highlighter-rouge">select</code> example above, feel free to pass an object
164
- specifying the fields for each relationship.</p>
165
-
166
- <div class="clearfix">
167
- <h2 id="next">
168
- <a href="/1.13/js/reads/statistics">
169
- NEXT:
170
- <small>Statistics</small>
171
- &raquo;
172
- </a>
173
- </h2>
174
- </div>
175
- </div>
176
-
177
- </div>
178
- </div>
179
- </main>
180
- <div class="main-footer main-footer--dark">
181
- <div class="container">
182
- <div class="row">
183
- <div class="col-sm-4 menu">
184
- <h3>Overview</h3>
185
- <ul>
186
- <li>
187
- <a href="/1.13/quickstart">Quickstart</a>
188
- </li>
189
- <li>
190
- <a href="/1.13/tutorial">Tutorial</a>
191
- </li>
192
- <li>
193
- <a href="/1.13/guides">Guides</a>
194
- </li>
195
- </ul>
196
- </div>
197
- <div class="col-sm-4 menu">
198
- <h3>Contact</h3>
199
- <ul>
200
- <li>
201
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
202
- </li>
203
- <li>
204
- <a href="mailto:richmolj@gmail.com">Email</a>
205
- </li>
206
- </ul>
207
- </div>
208
- <div class="col-sm-4 menu">
209
- <h3>Related</h3>
210
- <ul>
211
- <li>
212
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
213
- </li>
214
- <li>
215
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
216
- </li>
217
- <li>
218
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
219
- </li>
220
- </ul>
221
- </div>
222
- </div>
223
- </div>
224
- </div>
225
-
226
- <script type="text/javascript">
227
- $(function () {
228
-
229
- var flipTabs = function() {
230
- var isTS = true;
231
- if (localStorage.getItem('js-lang') === 'javascript') {
232
- isTS = false;
233
- }
234
-
235
- $('.code-tabs').each(function(index, el) {
236
- if (isTS) {
237
- console.log('hiding js');
238
- $($(el).children()[1]).hide();
239
- $($(el).children()[0]).show();
240
- } else {
241
- console.log('hiding ts');
242
- $($(el).children()[0]).hide();
243
- $($(el).children()[1]).show();
244
- }
245
- });
246
-
247
- if (isTS) {
248
- $('.tab.typescript').addClass('active');
249
- $('.tab.javascript').removeClass('active');
250
- } else {
251
- $('.tab.typescript').removeClass('active');
252
- $('.tab.javascript').addClass('active');
253
- }
254
- }
255
-
256
- $('.tab').click(function() {
257
- if ($(this).hasClass('typescript')) {
258
- localStorage.setItem('js-lang', 'typescript');
259
- } else {
260
- localStorage.setItem('js-lang', 'javascript');
261
- }
262
-
263
- flipTabs();
264
- });
265
-
266
- flipTabs();
267
- })
268
- </script>
269
-
270
- </body>
271
- </html>
data/website/static/1.13/js/reads/filtering.html DELETED
@@ -1,289 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
- <meta charset="utf-8">
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
9
- <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
10
-
11
- <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
12
- <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
13
- <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
14
- <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
15
- <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
16
- <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
17
- <meta name="msapplication-TileColor" content="#F86DA7">
18
- <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
19
- <meta name="theme-color" content="#F86DA7">
20
-
21
- <title>Graphiti</title>
22
- <meta name="description" content="Stylish Graph APIs">
23
-
24
- <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
25
- <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
26
-
27
- <!-- Global site tag (gtag.js) - Google Analytics -->
28
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
29
- <script>
30
- window.dataLayer = window.dataLayer || [];
31
- function gtag(){dataLayer.push(arguments);}
32
- gtag('js', new Date());
33
-
34
- gtag('config', 'UA-127904727-1');
35
- </script>
36
-
37
- <!-- javascript -->
38
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
39
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
40
-
41
-
42
- </head>
43
-
44
-
45
- <body>
46
- <main class="page-content" aria-label="Content">
47
- <div class="wrapper">
48
- <header class="navbar navbar-inverse normal" role="banner">
49
- <div class="container">
50
- <div class="navbar-header">
51
- <a href="/1.13/1.13" class="navbar-brand">
52
- <img alt="logo" src="/1.13/assets/img/logo.png">
53
- </a>
54
- </div>
55
- <nav class="" role="navigation">
56
- <ul class="nav navbar-nav nav-links">
57
- <li>
58
- <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
59
- </li>
60
- <li>
61
- <a class="guides nav-link" href="/1.13/guides">Guides</a>
62
- </li>
63
- <li>
64
- <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
65
- </li>
66
- <li>
67
- <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
68
- </li>
69
- </ul>
70
- <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
71
- <li>
72
- <span class="star">⭐</span>
73
- <a href="https://github.com/graphiti-api/graphiti">
74
- <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
75
- </a>
76
- </li>
77
- </ul>
78
- </nav>
79
- </div>
80
- </header>
81
-
82
- <div class="container">
83
- <h1>
84
- Spraypaint
85
- <small>the isomorphic, framework-agnostic Graphiti ORM</small>
86
- </h1>
87
-
88
- <div class="js-toc col-md-3">
89
- <ul>
90
- <li><a href="/1.13/js/index">Home</a></li>
91
- <li><a href="/1.13/js/introduction">Introduction</a></li>
92
- <li><a href="/1.13/js/installation">Installation</a>
93
- <ul>
94
- <li><a href="/1.13/js/installation#typescript">Typescript</a></li>
95
- <li><a href="/1.13/js/installation#defining-models">Defining Models</a></li>
96
- <li><a href="/1.13/js/installation#connecting-to-the-api">Connecting to the API</a></li>
97
- <li><a href="/1.13/js/installation#defining-attributes">Defining Attributes</a></li>
98
- <li><a href="/1.13/js/installation#defining-relationships">Defining Relationships</a></li>
99
- </ul>
100
- </li>
101
- <li><a href="/1.13/js/reads">Reads</a>
102
- <ul>
103
- <li><a href="/1.13/js/reads/sorting">Sorting</a></li>
104
- <li><a href="/1.13/js/reads/pagination">Pagination</a></li>
105
- <li><a href="/1.13/js/reads/filtering">Filtering</a></li>
106
- <li><a href="/1.13/js/reads/fieldsets">Fieldsets</a></li>
107
- <li><a href="/1.13/js/reads/statistics">Statistics</a></li>
108
- <li><a href="/1.13/js/reads/includes">Includes</a></li>
109
- <li><a href="/1.13/js/reads/nested-queries">Nested Queries</a></li>
110
- </ul>
111
- </li>
112
- <li><a href="/1.13/js/writes">Writes</a>
113
- <ul>
114
- <li><a href="/1.13/js/writes/validations">Validations</a></li>
115
- <li><a href="/1.13/js/writes/dirty-tracking">Dirty Tracking</a></li>
116
- <li><a href="/1.13/js/writes/nested">Nested Writes</a></li>
117
- <li><a href="/1.13/js/writes/deferred">Deferred Action</a></li>
118
- </ul>
119
- </li>
120
- <li><a href="/1.13/js/middleware">Middleware</a></li>
121
- <li><a href="/1.13/js/authentication">Authentication</a></li>
122
- <li><a href="/1.13/js/state-syncing">State Syncing</a></li>
123
- <li><a href="/1.13/js/ddau">Data Down, Actions Up</a></li>
124
- <li><a href="/1.13/js/extra-params">Extra params</a></li>
125
- </ul>
126
- </div>
127
-
128
- <div class="col-md-8 col-md-offset-1">
129
- <h3 id="filtering">Filtering</h3>
130
-
131
- <p>Use <code class="language-plaintext highlighter-rouge">#where()</code> to apply filters:</p>
132
-
133
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">important</span><span class="p">:</span> <span class="kc">true</span> <span class="p">}).</span><span class="nf">all</span><span class="p">()</span></code></pre></figure>
134
-
135
- <blockquote class="url">
136
- <p>/posts?filter[important]=true</p>
137
- </blockquote>
138
-
139
- <p><code class="language-plaintext highlighter-rouge">#where()</code> clauses can be chained together. If the same key is seen
140
- twice, it will be overridden:</p>
141
-
142
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="nx">Post</span>
143
- <span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">important</span><span class="p">:</span> <span class="kc">true</span> <span class="p">})</span>
144
- <span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">ranking</span><span class="p">:</span> <span class="mi">10</span> <span class="p">})</span>
145
- <span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">important</span><span class="p">:</span> <span class="kc">false</span> <span class="p">})</span>
146
- <span class="p">.</span><span class="nf">all</span><span class="p">()</span></code></pre></figure>
147
-
148
- <blockquote class="url">
149
- <p>/posts?filter[important]=false&amp;filter[ranking]=10</p>
150
- </blockquote>
151
-
152
- <p><code class="language-plaintext highlighter-rouge">#where()</code> clauses are based on <strong>server implementation</strong>. The key
153
- should be exactly as the server understands it. Here are some common
154
- conventions we promote:</p>
155
-
156
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="c1">// id greater than 5</span>
157
- <span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">id_gt</span><span class="p">:</span> <span class="mi">5</span> <span class="p">}).</span><span class="nf">all</span><span class="p">()</span>
158
-
159
- <span class="c1">// id greater than or equal to 5</span>
160
- <span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">id_gte</span><span class="p">:</span> <span class="mi">5</span> <span class="p">}).</span><span class="nf">all</span><span class="p">()</span>
161
-
162
- <span class="c1">// id less than 5</span>
163
- <span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">id_lt</span><span class="p">:</span> <span class="mi">5</span> <span class="p">}).</span><span class="nf">all</span><span class="p">()</span>
164
-
165
- <span class="c1">// id less or equal to 5</span>
166
- <span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">id_lte</span><span class="p">:</span> <span class="mi">5</span> <span class="p">}).</span><span class="nf">all</span><span class="p">()</span>
167
-
168
- <span class="c1">// title starts with "foo"</span>
169
- <span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">title</span><span class="p">:</span> <span class="p">{</span> <span class="na">prefix</span><span class="p">:</span> <span class="dl">"</span><span class="s2">foo</span><span class="dl">"</span> <span class="p">}</span> <span class="p">}).</span><span class="nf">all</span><span class="p">()</span>
170
-
171
- <span class="c1">// OR these two values</span>
172
- <span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">status_or</span><span class="p">:</span> <span class="p">[</span><span class="dl">'</span><span class="s1">draft</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">review</span><span class="dl">'</span><span class="p">]</span> <span class="p">})</span>
173
-
174
- <span class="c1">// AND these two values (default)</span>
175
- <span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">status</span><span class="p">:</span> <span class="p">[</span><span class="dl">'</span><span class="s1">draft</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">review</span><span class="dl">'</span><span class="p">]</span> <span class="p">})</span></code></pre></figure>
176
-
177
- <h4 id="escaping-values">Escaping Values</h4>
178
-
179
- <p><a href="/1.13/guides/concepts/resources#escaping-values">Graphiti treats a comma as a delimiter of multiple values</a>. To escape the
180
- comma and tell Graphiti this is a single value, wrap it in <code class="language-plaintext highlighter-rouge">{{curlies}}</code>:</p>
181
-
182
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="nx">Post</span><span class="p">.</span><span class="nf">where</span><span class="p">({</span> <span class="na">title</span><span class="p">:</span> <span class="dl">"</span><span class="s2">{{Hello World, here I am}}</span><span class="dl">"</span> <span class="p">})</span></code></pre></figure>
183
-
184
- <div class="clearfix">
185
- <h2 id="next">
186
- <a href="/1.13/js/reads/fieldsets">
187
- NEXT:
188
- <small>Fieldsets</small>
189
- &raquo;
190
- </a>
191
- </h2>
192
- </div>
193
- </div>
194
-
195
- </div>
196
- </div>
197
- </main>
198
- <div class="main-footer main-footer--dark">
199
- <div class="container">
200
- <div class="row">
201
- <div class="col-sm-4 menu">
202
- <h3>Overview</h3>
203
- <ul>
204
- <li>
205
- <a href="/1.13/quickstart">Quickstart</a>
206
- </li>
207
- <li>
208
- <a href="/1.13/tutorial">Tutorial</a>
209
- </li>
210
- <li>
211
- <a href="/1.13/guides">Guides</a>
212
- </li>
213
- </ul>
214
- </div>
215
- <div class="col-sm-4 menu">
216
- <h3>Contact</h3>
217
- <ul>
218
- <li>
219
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
220
- </li>
221
- <li>
222
- <a href="mailto:richmolj@gmail.com">Email</a>
223
- </li>
224
- </ul>
225
- </div>
226
- <div class="col-sm-4 menu">
227
- <h3>Related</h3>
228
- <ul>
229
- <li>
230
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
231
- </li>
232
- <li>
233
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
234
- </li>
235
- <li>
236
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
237
- </li>
238
- </ul>
239
- </div>
240
- </div>
241
- </div>
242
- </div>
243
-
244
- <script type="text/javascript">
245
- $(function () {
246
-
247
- var flipTabs = function() {
248
- var isTS = true;
249
- if (localStorage.getItem('js-lang') === 'javascript') {
250
- isTS = false;
251
- }
252
-
253
- $('.code-tabs').each(function(index, el) {
254
- if (isTS) {
255
- console.log('hiding js');
256
- $($(el).children()[1]).hide();
257
- $($(el).children()[0]).show();
258
- } else {
259
- console.log('hiding ts');
260
- $($(el).children()[0]).hide();
261
- $($(el).children()[1]).show();
262
- }
263
- });
264
-
265
- if (isTS) {
266
- $('.tab.typescript').addClass('active');
267
- $('.tab.javascript').removeClass('active');
268
- } else {
269
- $('.tab.typescript').removeClass('active');
270
- $('.tab.javascript').addClass('active');
271
- }
272
- }
273
-
274
- $('.tab').click(function() {
275
- if ($(this).hasClass('typescript')) {
276
- localStorage.setItem('js-lang', 'typescript');
277
- } else {
278
- localStorage.setItem('js-lang', 'javascript');
279
- }
280
-
281
- flipTabs();
282
- });
283
-
284
- flipTabs();
285
- })
286
- </script>
287
-
288
- </body>
289
- </html>