graphiti 2.0.0.beta.6 → 2.0.0.beta.8

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 (246) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +55 -3
  4. data/.github/workflows/docs.yml +1 -1
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.gitignore +2 -0
  7. data/.standard.yml +6 -0
  8. data/CHANGELOG.md +54 -0
  9. data/CONTRIBUTING.md +3 -1
  10. data/README.md +13 -206
  11. data/Rakefile +6 -3
  12. data/UPGRADING.md +1 -1
  13. data/graphiti.gemspec +8 -4
  14. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  15. data/lib/generators/graphiti/install_generator.rb +1 -2
  16. data/lib/generators/graphiti/resource_generator.rb +6 -3
  17. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  18. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  19. data/lib/generators/graphiti/templates/index_request_spec.rb.erb +2 -2
  20. data/lib/generators/graphiti/templates/resource_reads_spec.rb.erb +4 -4
  21. data/lib/generators/graphiti/templates/show_request_spec.rb.erb +2 -2
  22. data/lib/graphiti/audit/report.rb +6 -6
  23. data/lib/graphiti/audit.rb +3 -4
  24. data/lib/graphiti/delegates/pagination.rb +2 -2
  25. data/lib/graphiti/deserializer.rb +3 -3
  26. data/lib/graphiti/errors.rb +6 -6
  27. data/lib/graphiti/extensions/temp_id.rb +1 -1
  28. data/lib/graphiti/query.rb +27 -8
  29. data/lib/graphiti/rails/context.rb +2 -1
  30. data/lib/graphiti/rails/controller.rb +3 -0
  31. data/lib/graphiti/rails/debugging.rb +1 -1
  32. data/lib/graphiti/rails/responders.rb +2 -1
  33. data/lib/graphiti/resource/configuration.rb +1 -0
  34. data/lib/graphiti/resource/dsl.rb +2 -2
  35. data/lib/graphiti/resource/interface.rb +3 -3
  36. data/lib/graphiti/resource/links.rb +1 -1
  37. data/lib/graphiti/resource/persistence.rb +1 -1
  38. data/lib/graphiti/resource/polymorphism.rb +1 -1
  39. data/lib/graphiti/resource.rb +2 -2
  40. data/lib/graphiti/resource_proxy.rb +0 -1
  41. data/lib/graphiti/runner.rb +8 -3
  42. data/lib/graphiti/scope.rb +13 -0
  43. data/lib/graphiti/scoping/filter.rb +5 -3
  44. data/lib/graphiti/scoping/paginate.rb +1 -1
  45. data/lib/graphiti/scoping/sort.rb +1 -1
  46. data/lib/graphiti/sideload/has_many.rb +1 -1
  47. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  48. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  49. data/lib/graphiti/spec_helpers.rb +5 -0
  50. data/lib/graphiti/types.rb +5 -1
  51. data/lib/graphiti/util/cache_debug.rb +3 -3
  52. data/lib/graphiti/util/hash.rb +1 -1
  53. data/lib/graphiti/util/persistence.rb +6 -6
  54. data/lib/graphiti/util/serializer_relationships.rb +1 -1
  55. data/lib/graphiti/version.rb +1 -1
  56. data/lib/tasks/graphiti.rake +1 -1
  57. data/package.json +1 -0
  58. metadata +31 -197
  59. data/docs/concepts/backends-and-models.md +0 -122
  60. data/docs/concepts/endpoints.md +0 -183
  61. data/docs/concepts/links.md +0 -212
  62. data/docs/concepts/overview.md +0 -80
  63. data/docs/concepts/persisting.md +0 -376
  64. data/docs/concepts/relationships.md +0 -627
  65. data/docs/concepts/resources.md +0 -677
  66. data/docs/getting-started/first-api.md +0 -289
  67. data/docs/getting-started/installation.md +0 -185
  68. data/docs/intro.md +0 -307
  69. data/docs/js/authentication.md +0 -63
  70. data/docs/js/ddau.md +0 -20
  71. data/docs/js/extra-params.md +0 -41
  72. data/docs/js/index.md +0 -112
  73. data/docs/js/installation.md +0 -120
  74. data/docs/js/middleware.md +0 -72
  75. data/docs/js/models.md +0 -202
  76. data/docs/js/reads.md +0 -494
  77. data/docs/js/state-syncing.md +0 -100
  78. data/docs/js/writes.md +0 -373
  79. data/docs/reference/vandal.md +0 -63
  80. data/docs/reference/why.md +0 -13
  81. data/docs/topics/authorization.md +0 -155
  82. data/docs/topics/caching.md +0 -55
  83. data/docs/topics/customizing-sideloads.md +0 -156
  84. data/docs/topics/debugging.md +0 -242
  85. data/docs/topics/error-handling.md +0 -210
  86. data/docs/topics/etags.md +0 -46
  87. data/docs/topics/hopping-relationships.md +0 -149
  88. data/docs/topics/json-attributes.md +0 -77
  89. data/docs/topics/openstruct-models.md +0 -50
  90. data/docs/topics/remote-resources.md +0 -291
  91. data/docs/topics/testing.md +0 -894
  92. data/docs/topics/without-activerecord.md +0 -324
  93. data/docs/tutorial/index.md +0 -58
  94. data/docs/tutorial/step_0.md +0 -107
  95. data/docs/tutorial/step_1.md +0 -199
  96. data/docs/tutorial/step_2.md +0 -312
  97. data/docs/tutorial/step_3.md +0 -142
  98. data/docs/tutorial/step_4.md +0 -135
  99. data/docs/tutorial/step_5.md +0 -69
  100. data/docs/tutorial/step_6.md +0 -82
  101. data/docs/tutorial/step_7.md +0 -205
  102. data/docs/tutorial/step_8.md +0 -128
  103. data/docs/tutorial/step_9.md +0 -171
  104. data/docs/upgrading.md +0 -266
  105. data/website/.gitignore +0 -20
  106. data/website/README.md +0 -43
  107. data/website/docusaurus.config.js +0 -197
  108. data/website/package-lock.json +0 -19474
  109. data/website/package.json +0 -46
  110. data/website/sidebars.js +0 -82
  111. data/website/src/css/custom.css +0 -85
  112. data/website/src/pages/markdown-page.mdx +0 -7
  113. data/website/static/.nojekyll +0 -0
  114. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  115. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  116. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  117. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  118. data/website/static/1.13/CNAME +0 -1
  119. data/website/static/1.13/README.md +0 -16
  120. data/website/static/1.13/assets/css/syntax.css +0 -60
  121. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  122. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  123. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  124. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  125. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  126. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  127. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  128. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  129. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  130. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  131. data/website/static/1.13/assets/img/backend.gif +0 -0
  132. data/website/static/1.13/assets/img/conformity.png +0 -0
  133. data/website/static/1.13/assets/img/error_payload.png +0 -0
  134. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  135. data/website/static/1.13/assets/img/gh.png +0 -0
  136. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  137. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  138. data/website/static/1.13/assets/img/logo-500.png +0 -0
  139. data/website/static/1.13/assets/img/logo.png +0 -0
  140. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  141. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  142. data/website/static/1.13/assets/img/persist.jpg +0 -0
  143. data/website/static/1.13/assets/img/resource.gif +0 -0
  144. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  145. data/website/static/1.13/assets/img/rest1.gif +0 -0
  146. data/website/static/1.13/assets/img/rest2.gif +0 -0
  147. data/website/static/1.13/assets/img/rest3.gif +0 -0
  148. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  149. data/website/static/1.13/assets/img/sunrise.png +0 -0
  150. data/website/static/1.13/assets/img/why.png +0 -0
  151. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  152. data/website/static/1.13/assets/main.css +0 -15518
  153. data/website/static/1.13/assets/main.css.map +0 -1
  154. data/website/static/1.13/bin/bundle +0 -109
  155. data/website/static/1.13/bin/jekyll +0 -27
  156. data/website/static/1.13/bin/kramdown +0 -27
  157. data/website/static/1.13/bin/listen +0 -27
  158. data/website/static/1.13/bin/rake +0 -27
  159. data/website/static/1.13/bin/rougify +0 -27
  160. data/website/static/1.13/bin/safe_yaml +0 -27
  161. data/website/static/1.13/bin/sass +0 -27
  162. data/website/static/1.13/bin/sass-convert +0 -27
  163. data/website/static/1.13/bin/scss +0 -27
  164. data/website/static/1.13/blog.html +0 -259
  165. data/website/static/1.13/cheatsheet.html +0 -316
  166. data/website/static/1.13/cookbooks/authorization.md +0 -0
  167. data/website/static/1.13/cookbooks/caching.md +0 -0
  168. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  169. data/website/static/1.13/cookbooks/etags.md +0 -0
  170. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  171. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  172. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  173. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  174. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  175. data/website/static/1.13/features.html +0 -249
  176. data/website/static/1.13/feed.xml +0 -106
  177. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  178. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  179. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  180. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  181. data/website/static/1.13/guides/concepts/links.html +0 -501
  182. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  183. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  184. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  185. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  186. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  187. data/website/static/1.13/guides/index.html +0 -269
  188. data/website/static/1.13/guides/overview.html +0 -325
  189. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  190. data/website/static/1.13/guides/upgrading.html +0 -314
  191. data/website/static/1.13/guides/vandal.html +0 -282
  192. data/website/static/1.13/guides/why.html +0 -1121
  193. data/website/static/1.13/index.html +0 -72
  194. data/website/static/1.13/js/authentication.html +0 -295
  195. data/website/static/1.13/js/ddau.html +0 -238
  196. data/website/static/1.13/js/extra-params.html +0 -270
  197. data/website/static/1.13/js/index.html +0 -321
  198. data/website/static/1.13/js/installation.html +0 -637
  199. data/website/static/1.13/js/introduction.html +0 -257
  200. data/website/static/1.13/js/middleware.html +0 -318
  201. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  202. data/website/static/1.13/js/reads/filtering.html +0 -289
  203. data/website/static/1.13/js/reads/includes.html +0 -260
  204. data/website/static/1.13/js/reads/index.html +0 -497
  205. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  206. data/website/static/1.13/js/reads/pagination.html +0 -260
  207. data/website/static/1.13/js/reads/sorting.html +0 -265
  208. data/website/static/1.13/js/reads/statistics.html +0 -289
  209. data/website/static/1.13/js/state-syncing.html +0 -340
  210. data/website/static/1.13/js/writes/deferred.html +0 -296
  211. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  212. data/website/static/1.13/js/writes/index.html +0 -391
  213. data/website/static/1.13/js/writes/nested.html +0 -330
  214. data/website/static/1.13/js/writes/validations.html +0 -272
  215. data/website/static/1.13/quickstart.html +0 -660
  216. data/website/static/1.13/template +0 -161
  217. data/website/static/1.13/tutorial/index.html +0 -250
  218. data/website/static/1.13/tutorial/step_0.html +0 -292
  219. data/website/static/1.13/tutorial/step_1.html +0 -517
  220. data/website/static/1.13/tutorial/step_2.html +0 -481
  221. data/website/static/1.13/tutorial/step_3.html +0 -323
  222. data/website/static/1.13/tutorial/step_4.html +0 -318
  223. data/website/static/1.13/tutorial/step_5.html +0 -265
  224. data/website/static/1.13/tutorial/step_6.html +0 -276
  225. data/website/static/1.13/tutorial/step_7.html +0 -390
  226. data/website/static/1.13/tutorial/step_8.html +0 -316
  227. data/website/static/1.13/tutorial/step_9.html +0 -365
  228. data/website/static/CNAME +0 -1
  229. data/website/static/assets/img/error_payload.png +0 -0
  230. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  231. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  232. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  233. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  234. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  235. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  236. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  237. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  238. data/website/static/assets/img/meta_total_count.png +0 -0
  239. data/website/static/img/docusaurus-social-card.jpg +0 -0
  240. data/website/static/img/docusaurus.png +0 -0
  241. data/website/static/img/favicon.ico +0 -0
  242. data/website/static/img/logo.png +0 -0
  243. data/website/static/img/logo.svg +0 -1
  244. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  245. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  246. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/js/writes/index.html DELETED
@@ -1,391 +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="writes">Writes</h3>
130
-
131
- <p>Similar to <code class="language-plaintext highlighter-rouge">ActiveRecord</code>, you can simply call <code class="language-plaintext highlighter-rouge">#save()</code> on a model
132
- instance. Spraypaint will <a href="http://jsonapi.org/format/#crud-creating">create</a> (<code class="language-plaintext highlighter-rouge">POST</code>) or <a href="http://jsonapi.org/format/#crud-updating">update</a> (<code class="language-plaintext highlighter-rouge">PATCH</code>) as needed.</p>
133
-
134
- <p><code class="language-plaintext highlighter-rouge">#save()</code> returns a <code class="language-plaintext highlighter-rouge">Promise</code> that will resolve a <code class="language-plaintext highlighter-rouge">boolean</code> - <code class="language-plaintext highlighter-rouge">true</code>
135
- when the server returns a 200-ish response code, <code class="language-plaintext highlighter-rouge">false</code> when the server
136
- returns a <code class="language-plaintext highlighter-rouge">422</code> response code (see
137
- <a href="/1.13/js/writes/validations">validations</a>). As always, anything else will
138
- reject the promise.</p>
139
-
140
- <div class="tabs">
141
- <div class="tab typescript active">
142
- <span>Typescript</span>
143
- </div>
144
- <div class="tab javascript">
145
- <span>Javascript</span>
146
- </div>
147
- </div>
148
-
149
- <div class="code-tabs">
150
-
151
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"> <span class="kd">let</span> <span class="nx">blog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Blog</span><span class="p">({</span> <span class="na">title</span><span class="p">:</span> <span class="dl">"</span><span class="s2">My Blog</span><span class="dl">"</span> <span class="p">})</span>
152
- <span class="kd">let</span> <span class="nx">success</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span> <span class="c1">// POST /blogs</span>
153
- <span class="nx">console</span><span class="p">.</span><span class="nf">log</span><span class="p">(</span><span class="nx">success</span><span class="p">)</span> <span class="c1">// true/false</span>
154
-
155
- <span class="nx">blog</span><span class="p">.</span><span class="nx">title</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">Updated Title</span><span class="dl">"</span>
156
- <span class="nx">success</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span> <span class="c1">// PUT /blogs/:id</span>
157
- <span class="nx">console</span><span class="p">.</span><span class="nf">log</span><span class="p">(</span><span class="nx">success</span><span class="p">)</span> <span class="c1">// true/false</span>
158
- </code></pre></figure>
159
-
160
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"> <span class="kd">var</span> <span class="nx">blog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Blog</span><span class="p">({</span> <span class="na">title</span><span class="p">:</span> <span class="dl">"</span><span class="s2">My Blog</span><span class="dl">"</span> <span class="p">});</span>
161
- <span class="c1">// POST /blogs</span>
162
- <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">().</span><span class="nf">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">success</span><span class="p">)</span> <span class="p">{</span>
163
- <span class="nx">console</span><span class="p">.</span><span class="nf">log</span><span class="p">(</span><span class="nx">success</span><span class="p">);</span> <span class="c1">// true/false</span>
164
-
165
- <span class="nx">blog</span><span class="p">.</span><span class="nx">title</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">Updated Title</span><span class="dl">"</span><span class="p">:</span>
166
- <span class="c1">// PUT /blogs/:id</span>
167
- <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">().</span><span class="nf">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">success</span><span class="p">)</span> <span class="p">{</span>
168
- <span class="nx">console</span><span class="p">.</span><span class="nf">log</span><span class="p">(</span><span class="nx">success</span><span class="p">)</span> <span class="c1">// true/false</span>
169
- <span class="p">});</span>
170
- <span class="p">});</span>
171
- </code></pre></figure>
172
-
173
- </div>
174
-
175
- <p>After saving, the instance will automatically pick up any
176
- server-assigned attributes:</p>
177
-
178
- <div class="tabs">
179
- <div class="tab typescript active">
180
- <span>Typescript</span>
181
- </div>
182
- <div class="tab javascript">
183
- <span>Javascript</span>
184
- </div>
185
- </div>
186
-
187
- <div class="code-tabs">
188
-
189
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"> <span class="kd">let</span> <span class="nx">post</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Post</span><span class="p">()</span>
190
- <span class="k">await</span> <span class="nx">post</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span>
191
- <span class="nx">post</span><span class="p">.</span><span class="nx">id</span> <span class="c1">// server-assigned value</span>
192
- <span class="nx">post</span><span class="p">.</span><span class="nx">createdAt</span> <span class="c1">// server-assigned value</span>
193
- </code></pre></figure>
194
-
195
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"> <span class="kd">var</span> <span class="nx">post</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Post</span><span class="p">();</span>
196
- <span class="nx">post</span><span class="p">.</span><span class="nf">save</span><span class="p">().</span><span class="nf">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">success</span><span class="p">)</span> <span class="p">{</span>
197
- <span class="nx">post</span><span class="p">.</span><span class="nx">id</span> <span class="c1">// server-assigned value</span>
198
- <span class="nx">post</span><span class="p">.</span><span class="nx">createdAt</span> <span class="c1">// server-assigned value</span>
199
- <span class="p">});</span>
200
- </code></pre></figure>
201
-
202
- </div>
203
-
204
- <p>If a <code class="language-plaintext highlighter-rouge">Model</code> was instantiated with data from the server, <code class="language-plaintext highlighter-rouge">isPersisted</code>
205
- will return <code class="language-plaintext highlighter-rouge">true</code>. This means that we can assign IDs on the client
206
- without any adverse behavior; we can also manually mark objects as
207
- persisted for testing purposes:</p>
208
-
209
- <div class="tabs">
210
- <div class="tab typescript active">
211
- <span>Typescript</span>
212
- </div>
213
- <div class="tab javascript">
214
- <span>Javascript</span>
215
- </div>
216
- </div>
217
-
218
- <div class="code-tabs">
219
-
220
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"> <span class="kd">let</span> <span class="nx">blog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Blog</span><span class="p">({</span> <span class="na">id</span><span class="p">:</span> <span class="mi">123</span> <span class="p">})</span>
221
- <span class="nx">blog</span><span class="p">.</span><span class="nx">isPersisted</span> <span class="c1">// false</span>
222
- <span class="k">await</span> <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span> <span class="c1">// POST /blogs</span>
223
- <span class="nx">blog</span><span class="p">.</span><span class="nx">isPersisted</span> <span class="c1">// true</span>
224
- <span class="nx">blog</span><span class="p">.</span><span class="nx">id</span> <span class="c1">// 123</span>
225
-
226
- <span class="c1">// Manually mark an instance as persisted</span>
227
- <span class="nx">blog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Blog</span><span class="p">({</span> <span class="na">id</span><span class="p">:</span> <span class="mi">123</span> <span class="p">})</span>
228
- <span class="nx">blog</span><span class="p">.</span><span class="nx">isPersisted</span> <span class="o">=</span> <span class="kc">true</span>
229
- <span class="k">await</span> <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span> <span class="c1">// PUT /blogs/123</span>
230
- </code></pre></figure>
231
-
232
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"> <span class="kd">var</span> <span class="nx">blog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Blog</span><span class="p">({</span> <span class="na">id</span><span class="p">:</span> <span class="mi">123</span> <span class="p">});</span>
233
- <span class="nx">blog</span><span class="p">.</span><span class="nx">isPersisted</span> <span class="c1">// false</span>
234
- <span class="c1">// POST /blogs</span>
235
- <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">().</span><span class="nf">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
236
- <span class="nx">blog</span><span class="p">.</span><span class="nx">isPersisted</span> <span class="c1">// true</span>
237
- <span class="nx">blog</span><span class="p">.</span><span class="nx">id</span> <span class="c1">// 123</span>
238
- <span class="p">});</span>
239
-
240
- <span class="c1">// Manually mark an instance as persisted</span>
241
- <span class="kd">var</span> <span class="nx">blog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Blog</span><span class="p">({</span> <span class="na">id</span><span class="p">:</span> <span class="mi">123</span> <span class="p">});</span>
242
- <span class="nx">blog</span><span class="p">.</span><span class="nx">isPersisted</span> <span class="o">=</span> <span class="kc">true</span>
243
- <span class="nx">blog</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span> <span class="c1">// PUT /blogs/123</span>
244
- </code></pre></figure>
245
-
246
- </div>
247
-
248
- <p>Notably, <strong>only dirty (changed) attributes will be sent to the server</strong>. This prevents race conditions and unexpected side-effects. In the following example, <code class="language-plaintext highlighter-rouge">Post</code> has attributes <code class="language-plaintext highlighter-rouge">title</code>, <code class="language-plaintext highlighter-rouge">description</code>, and <code class="language-plaintext highlighter-rouge">createdAt</code>:</p>
249
-
250
- <div class="tabs">
251
- <div class="tab typescript active">
252
- <span>Typescript</span>
253
- </div>
254
- <div class="tab javascript">
255
- <span>Javascript</span>
256
- </div>
257
- </div>
258
-
259
- <div class="code-tabs">
260
-
261
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"> <span class="kd">let</span> <span class="nx">post</span> <span class="o">=</span> <span class="p">(</span><span class="k">await</span> <span class="nx">Post</span><span class="p">.</span><span class="nf">first</span><span class="p">())</span>
262
- <span class="nx">post</span><span class="p">.</span><span class="nx">title</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">updated</span><span class="dl">"</span>
263
- <span class="c1">// ONLY title sent to the server</span>
264
- <span class="k">await</span> <span class="nx">post</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span>
265
- <span class="c1">// Title is now synced with the server</span>
266
- <span class="nx">post</span><span class="p">.</span><span class="nx">description</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">updated</span><span class="dl">"</span>
267
- <span class="c1">// ONLY description sent to the server</span>
268
- <span class="k">await</span> <span class="nx">post</span><span class="p">.</span><span class="nf">save</span><span class="p">()</span>
269
- </code></pre></figure>
270
-
271
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"> <span class="nx">Post</span><span class="p">.</span><span class="nf">first</span><span class="p">().</span><span class="nf">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
272
- <span class="kd">var</span> <span class="nx">post</span> <span class="o">=</span> <span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">;</span>
273
- <span class="nx">post</span><span class="p">.</span><span class="nx">title</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">updated</span><span class="dl">"</span><span class="p">;</span>
274
- <span class="c1">// ONLY title sent to the server</span>
275
- <span class="nx">post</span><span class="p">.</span><span class="nf">save</span><span class="p">().</span><span class="nf">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
276
- <span class="c1">// Title is now synced with the server</span>
277
- <span class="nx">post</span><span class="p">.</span><span class="nx">description</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">updated</span><span class="dl">"</span><span class="p">;</span>
278
- <span class="c1">// ONLY description sent to the server</span>
279
- <span class="nx">post</span><span class="p">.</span><span class="nf">save</span><span class="p">();</span>
280
- <span class="p">});</span>
281
- <span class="p">});</span>
282
- </code></pre></figure>
283
-
284
- </div>
285
-
286
- <div class="clearfix">
287
- <h2 id="next">
288
- <a href="/1.13/js/writes/validations">
289
- NEXT:
290
- <small>Validations</small>
291
- &raquo;
292
- </a>
293
- </h2>
294
- </div>
295
- </div>
296
-
297
- </div>
298
- </div>
299
- </main>
300
- <div class="main-footer main-footer--dark">
301
- <div class="container">
302
- <div class="row">
303
- <div class="col-sm-4 menu">
304
- <h3>Overview</h3>
305
- <ul>
306
- <li>
307
- <a href="/1.13/quickstart">Quickstart</a>
308
- </li>
309
- <li>
310
- <a href="/1.13/tutorial">Tutorial</a>
311
- </li>
312
- <li>
313
- <a href="/1.13/guides">Guides</a>
314
- </li>
315
- </ul>
316
- </div>
317
- <div class="col-sm-4 menu">
318
- <h3>Contact</h3>
319
- <ul>
320
- <li>
321
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
322
- </li>
323
- <li>
324
- <a href="mailto:richmolj@gmail.com">Email</a>
325
- </li>
326
- </ul>
327
- </div>
328
- <div class="col-sm-4 menu">
329
- <h3>Related</h3>
330
- <ul>
331
- <li>
332
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
333
- </li>
334
- <li>
335
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
336
- </li>
337
- <li>
338
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
339
- </li>
340
- </ul>
341
- </div>
342
- </div>
343
- </div>
344
- </div>
345
-
346
- <script type="text/javascript">
347
- $(function () {
348
-
349
- var flipTabs = function() {
350
- var isTS = true;
351
- if (localStorage.getItem('js-lang') === 'javascript') {
352
- isTS = false;
353
- }
354
-
355
- $('.code-tabs').each(function(index, el) {
356
- if (isTS) {
357
- console.log('hiding js');
358
- $($(el).children()[1]).hide();
359
- $($(el).children()[0]).show();
360
- } else {
361
- console.log('hiding ts');
362
- $($(el).children()[0]).hide();
363
- $($(el).children()[1]).show();
364
- }
365
- });
366
-
367
- if (isTS) {
368
- $('.tab.typescript').addClass('active');
369
- $('.tab.javascript').removeClass('active');
370
- } else {
371
- $('.tab.typescript').removeClass('active');
372
- $('.tab.javascript').addClass('active');
373
- }
374
- }
375
-
376
- $('.tab').click(function() {
377
- if ($(this).hasClass('typescript')) {
378
- localStorage.setItem('js-lang', 'typescript');
379
- } else {
380
- localStorage.setItem('js-lang', 'javascript');
381
- }
382
-
383
- flipTabs();
384
- });
385
-
386
- flipTabs();
387
- })
388
- </script>
389
-
390
- </body>
391
- </html>