@warp-drive/legacy 5.9.0-beta.0 → 5.9.0-beta.2

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 (468) hide show
  1. package/README.md +6 -0
  2. package/dist/-private-DQ6Iap2t.js +193 -0
  3. package/dist/-private-DQ6Iap2t.js.map +1 -0
  4. package/dist/-private-DccRZQsm.js +904 -0
  5. package/dist/-private-DccRZQsm.js.map +1 -0
  6. package/dist/adapter/-private.d.ts +33 -0
  7. package/dist/adapter/-private.d.ts.map +1 -0
  8. package/dist/adapter/-private.js +3 -1
  9. package/dist/adapter/error.d.ts +2 -0
  10. package/dist/adapter/error.js +425 -311
  11. package/dist/adapter/error.js.map +1 -0
  12. package/{declarations → dist}/adapter/json-api.d.ts +31 -19
  13. package/dist/adapter/json-api.d.ts.map +1 -0
  14. package/dist/adapter/json-api.js +265 -131
  15. package/dist/adapter/json-api.js.map +1 -0
  16. package/dist/adapter/rest.d.ts +2 -0
  17. package/dist/adapter/rest.js +937 -1100
  18. package/dist/adapter/rest.js.map +1 -0
  19. package/dist/adapter-CARrK3-8.d.ts +784 -0
  20. package/dist/adapter-CARrK3-8.d.ts.map +1 -0
  21. package/dist/adapter-eYo2pIuM.js +1130 -0
  22. package/dist/adapter-eYo2pIuM.js.map +1 -0
  23. package/dist/adapter.d.ts +2 -0
  24. package/dist/adapter.js +1 -1251
  25. package/dist/compat/-private.d.ts +2 -0
  26. package/dist/compat/-private.js +3 -1
  27. package/dist/compat/builders.d.ts +169 -0
  28. package/dist/compat/builders.d.ts.map +1 -0
  29. package/dist/compat/builders.js +205 -246
  30. package/dist/compat/builders.js.map +1 -0
  31. package/dist/compat/extensions.d.ts +2 -0
  32. package/dist/compat/extensions.js +271 -233
  33. package/dist/compat/extensions.js.map +1 -0
  34. package/dist/compat/utils.d.ts +151 -0
  35. package/dist/compat/utils.d.ts.map +1 -0
  36. package/dist/compat/utils.js +189 -194
  37. package/dist/compat/utils.js.map +1 -0
  38. package/dist/compat-BbNNmTM-.d.ts +1386 -0
  39. package/dist/compat-BbNNmTM-.d.ts.map +1 -0
  40. package/dist/compat-DcHVxuuZ.js +734 -0
  41. package/dist/compat-DcHVxuuZ.js.map +1 -0
  42. package/dist/compat.d.ts +2 -0
  43. package/dist/compat.js +1 -1019
  44. package/dist/error-CzkyXr1Q.d.ts +435 -0
  45. package/dist/error-CzkyXr1Q.d.ts.map +1 -0
  46. package/dist/errors-BEEsrHbl.js +2134 -0
  47. package/dist/errors-BEEsrHbl.js.map +1 -0
  48. package/dist/extensions-DumNm4dA.d.ts +102 -0
  49. package/dist/extensions-DumNm4dA.d.ts.map +1 -0
  50. package/dist/index.d.ts +243 -0
  51. package/dist/index.d.ts.map +1 -0
  52. package/dist/index.js +271 -188
  53. package/dist/index.js.map +1 -0
  54. package/dist/json-BXNPTlcH.js +1106 -0
  55. package/dist/json-BXNPTlcH.js.map +1 -0
  56. package/dist/model/-private.d.ts +3 -0
  57. package/dist/model/-private.js +3 -1
  58. package/dist/model/migration-support.d.ts +335 -0
  59. package/dist/model/migration-support.d.ts.map +1 -0
  60. package/dist/model/migration-support.js +506 -564
  61. package/dist/model/migration-support.js.map +1 -0
  62. package/dist/model-62hn5_PD.d.ts +3107 -0
  63. package/dist/model-62hn5_PD.d.ts.map +1 -0
  64. package/dist/model-DcXZdNMu.js +683 -0
  65. package/dist/model-DcXZdNMu.js.map +1 -0
  66. package/dist/model-fragments-DSqu0ptR.js +334 -0
  67. package/dist/model-fragments-DSqu0ptR.js.map +1 -0
  68. package/dist/model-fragments.d.ts +294 -0
  69. package/dist/model-fragments.d.ts.map +1 -0
  70. package/dist/model-fragments.js +2 -75
  71. package/dist/model.d.ts +404 -0
  72. package/dist/model.d.ts.map +1 -0
  73. package/dist/model.js +3 -666
  74. package/{declarations/adapter/rest.d.ts → dist/rest-0NhtexIq.d.ts} +187 -103
  75. package/dist/rest-0NhtexIq.d.ts.map +1 -0
  76. package/dist/runtime--fcdnjmJ-DMTJ0Kb3.js +53 -0
  77. package/dist/runtime--fcdnjmJ-DMTJ0Kb3.js.map +1 -0
  78. package/dist/schema-provider-H4zNXtry.js +1929 -0
  79. package/dist/schema-provider-H4zNXtry.js.map +1 -0
  80. package/{declarations → dist}/serializer/json-api.d.ts +4 -1
  81. package/dist/serializer/json-api.d.ts.map +1 -0
  82. package/dist/serializer/json-api.js +527 -514
  83. package/dist/serializer/json-api.js.map +1 -0
  84. package/{declarations → dist}/serializer/json.d.ts +3 -0
  85. package/dist/serializer/json.d.ts.map +1 -0
  86. package/dist/serializer/json.js +3 -6
  87. package/{declarations/serializer/-private/embedded-records-mixin.d.ts → dist/serializer/rest.d.ts} +56 -1
  88. package/dist/serializer/rest.d.ts.map +1 -0
  89. package/dist/serializer/rest.js +958 -1200
  90. package/dist/serializer/rest.js.map +1 -0
  91. package/dist/serializer/transform.d.ts +313 -0
  92. package/dist/serializer/transform.d.ts.map +1 -0
  93. package/dist/serializer/transform.js +283 -260
  94. package/dist/serializer/transform.js.map +1 -0
  95. package/dist/serializer.d.ts +151 -0
  96. package/dist/serializer.d.ts.map +1 -0
  97. package/dist/serializer.js +205 -208
  98. package/dist/serializer.js.map +1 -0
  99. package/dist/store-C4qYzXei.js +473 -0
  100. package/dist/store-C4qYzXei.js.map +1 -0
  101. package/dist/store.d.ts +13 -0
  102. package/dist/store.d.ts.map +1 -0
  103. package/dist/store.js +1 -635
  104. package/dist/unpkg/dev/-private-CrEyBE-B.js +189 -0
  105. package/dist/unpkg/dev/-private-CrEyBE-B.js.map +1 -0
  106. package/dist/unpkg/dev/-private-vOhxVExH.js +896 -0
  107. package/dist/unpkg/dev/-private-vOhxVExH.js.map +1 -0
  108. package/dist/unpkg/dev/adapter/-private.js +3 -1
  109. package/dist/unpkg/dev/adapter/error.js +424 -310
  110. package/dist/unpkg/dev/adapter/error.js.map +1 -0
  111. package/dist/unpkg/dev/adapter/json-api.js +239 -245
  112. package/dist/unpkg/dev/adapter/json-api.js.map +1 -0
  113. package/dist/unpkg/dev/adapter/rest.js +935 -1098
  114. package/dist/unpkg/dev/adapter/rest.js.map +1 -0
  115. package/dist/unpkg/dev/adapter-oLwyr47q.js +1129 -0
  116. package/dist/unpkg/dev/adapter-oLwyr47q.js.map +1 -0
  117. package/dist/unpkg/dev/adapter.js +1 -1250
  118. package/dist/unpkg/dev/compat/-private.js +3 -1
  119. package/dist/unpkg/dev/compat/builders.js +204 -248
  120. package/dist/unpkg/dev/compat/builders.js.map +1 -0
  121. package/dist/unpkg/dev/compat/extensions.js +270 -232
  122. package/dist/unpkg/dev/compat/extensions.js.map +1 -0
  123. package/dist/unpkg/dev/compat/utils.js +188 -193
  124. package/dist/unpkg/dev/compat/utils.js.map +1 -0
  125. package/dist/unpkg/dev/compat-D48B8sXv.js +825 -0
  126. package/dist/unpkg/dev/compat-D48B8sXv.js.map +1 -0
  127. package/dist/unpkg/dev/compat.js +1 -1145
  128. package/dist/unpkg/dev/errors-8GnRWcxo.js +2127 -0
  129. package/dist/unpkg/dev/errors-8GnRWcxo.js.map +1 -0
  130. package/dist/unpkg/dev/index.js +270 -190
  131. package/dist/unpkg/dev/index.js.map +1 -0
  132. package/dist/unpkg/dev/json-DDJji3V3.js +1104 -0
  133. package/dist/unpkg/dev/json-DDJji3V3.js.map +1 -0
  134. package/dist/unpkg/dev/model/-private.js +3 -1
  135. package/dist/unpkg/dev/model/migration-support.js +483 -537
  136. package/dist/unpkg/dev/model/migration-support.js.map +1 -0
  137. package/dist/unpkg/dev/model-LK7ethC5.js +655 -0
  138. package/dist/unpkg/dev/model-LK7ethC5.js.map +1 -0
  139. package/dist/unpkg/dev/model-fragments-DSqu0ptR.js +334 -0
  140. package/dist/unpkg/dev/model-fragments-DSqu0ptR.js.map +1 -0
  141. package/dist/unpkg/dev/model-fragments.js +2 -75
  142. package/dist/unpkg/dev/model.js +3 -677
  143. package/dist/unpkg/dev/runtime--fcdnjmJ-DMTJ0Kb3.js +53 -0
  144. package/dist/unpkg/dev/runtime--fcdnjmJ-DMTJ0Kb3.js.map +1 -0
  145. package/dist/unpkg/dev/schema-provider-CRzoMoTO.js +1834 -0
  146. package/dist/unpkg/dev/schema-provider-CRzoMoTO.js.map +1 -0
  147. package/dist/unpkg/dev/serializer/json-api.js +514 -629
  148. package/dist/unpkg/dev/serializer/json-api.js.map +1 -0
  149. package/dist/unpkg/dev/serializer/json.js +3 -4
  150. package/dist/unpkg/dev/serializer/rest.js +954 -1197
  151. package/dist/unpkg/dev/serializer/rest.js.map +1 -0
  152. package/dist/unpkg/dev/serializer/transform.js +283 -260
  153. package/dist/unpkg/dev/serializer/transform.js.map +1 -0
  154. package/dist/unpkg/dev/serializer.js +205 -208
  155. package/dist/unpkg/dev/serializer.js.map +1 -0
  156. package/dist/unpkg/dev/store-D_V8-HQl.js +472 -0
  157. package/dist/unpkg/dev/store-D_V8-HQl.js.map +1 -0
  158. package/dist/unpkg/dev/store.js +1 -635
  159. package/dist/unpkg/dev/util-dSKEgQDp.js +12 -0
  160. package/dist/unpkg/dev/util-dSKEgQDp.js.map +1 -0
  161. package/dist/unpkg/dev/utils-DYC9utVJ.js +11 -0
  162. package/dist/unpkg/dev/utils-DYC9utVJ.js.map +1 -0
  163. package/dist/unpkg/dev-deprecated/-private-CrEyBE-B.js +189 -0
  164. package/dist/unpkg/dev-deprecated/-private-CrEyBE-B.js.map +1 -0
  165. package/dist/unpkg/dev-deprecated/-private-vOhxVExH.js +896 -0
  166. package/dist/unpkg/dev-deprecated/-private-vOhxVExH.js.map +1 -0
  167. package/dist/unpkg/dev-deprecated/adapter/-private.js +3 -1
  168. package/dist/unpkg/dev-deprecated/adapter/error.js +424 -310
  169. package/dist/unpkg/dev-deprecated/adapter/error.js.map +1 -0
  170. package/dist/unpkg/dev-deprecated/adapter/json-api.js +239 -245
  171. package/dist/unpkg/dev-deprecated/adapter/json-api.js.map +1 -0
  172. package/dist/unpkg/dev-deprecated/adapter/rest.js +935 -1098
  173. package/dist/unpkg/dev-deprecated/adapter/rest.js.map +1 -0
  174. package/dist/unpkg/dev-deprecated/adapter-oLwyr47q.js +1129 -0
  175. package/dist/unpkg/dev-deprecated/adapter-oLwyr47q.js.map +1 -0
  176. package/dist/unpkg/dev-deprecated/adapter.js +1 -1250
  177. package/dist/unpkg/dev-deprecated/compat/-private.js +3 -1
  178. package/dist/unpkg/dev-deprecated/compat/builders.js +204 -248
  179. package/dist/unpkg/dev-deprecated/compat/builders.js.map +1 -0
  180. package/dist/unpkg/dev-deprecated/compat/extensions.js +270 -232
  181. package/dist/unpkg/dev-deprecated/compat/extensions.js.map +1 -0
  182. package/dist/unpkg/dev-deprecated/compat/utils.js +188 -193
  183. package/dist/unpkg/dev-deprecated/compat/utils.js.map +1 -0
  184. package/dist/unpkg/dev-deprecated/compat-DGSurLh7.js +825 -0
  185. package/dist/unpkg/dev-deprecated/compat-DGSurLh7.js.map +1 -0
  186. package/dist/unpkg/dev-deprecated/compat.js +1 -1145
  187. package/dist/unpkg/dev-deprecated/errors-0ydn94s0.js +2128 -0
  188. package/dist/unpkg/dev-deprecated/errors-0ydn94s0.js.map +1 -0
  189. package/dist/unpkg/dev-deprecated/index.js +270 -189
  190. package/dist/unpkg/dev-deprecated/index.js.map +1 -0
  191. package/dist/unpkg/dev-deprecated/json-DDJji3V3.js +1104 -0
  192. package/dist/unpkg/dev-deprecated/json-DDJji3V3.js.map +1 -0
  193. package/dist/unpkg/dev-deprecated/model/-private.js +3 -1
  194. package/dist/unpkg/dev-deprecated/model/migration-support.js +494 -554
  195. package/dist/unpkg/dev-deprecated/model/migration-support.js.map +1 -0
  196. package/dist/unpkg/dev-deprecated/model-C1ts6Mod.js +660 -0
  197. package/dist/unpkg/dev-deprecated/model-C1ts6Mod.js.map +1 -0
  198. package/dist/unpkg/dev-deprecated/model-fragments-DSqu0ptR.js +334 -0
  199. package/dist/unpkg/dev-deprecated/model-fragments-DSqu0ptR.js.map +1 -0
  200. package/dist/unpkg/dev-deprecated/model-fragments.js +2 -75
  201. package/dist/unpkg/dev-deprecated/model.js +3 -681
  202. package/dist/unpkg/dev-deprecated/runtime--fcdnjmJ-DMTJ0Kb3.js +53 -0
  203. package/dist/unpkg/dev-deprecated/runtime--fcdnjmJ-DMTJ0Kb3.js.map +1 -0
  204. package/dist/unpkg/dev-deprecated/schema-provider-D2ESMsA8.js +1835 -0
  205. package/dist/unpkg/dev-deprecated/schema-provider-D2ESMsA8.js.map +1 -0
  206. package/dist/unpkg/dev-deprecated/serializer/json-api.js +514 -629
  207. package/dist/unpkg/dev-deprecated/serializer/json-api.js.map +1 -0
  208. package/dist/unpkg/dev-deprecated/serializer/json.js +3 -4
  209. package/dist/unpkg/dev-deprecated/serializer/rest.js +954 -1197
  210. package/dist/unpkg/dev-deprecated/serializer/rest.js.map +1 -0
  211. package/dist/unpkg/dev-deprecated/serializer/transform.js +283 -260
  212. package/dist/unpkg/dev-deprecated/serializer/transform.js.map +1 -0
  213. package/dist/unpkg/dev-deprecated/serializer.js +205 -208
  214. package/dist/unpkg/dev-deprecated/serializer.js.map +1 -0
  215. package/dist/unpkg/dev-deprecated/store-BX7GvXC_.js +472 -0
  216. package/dist/unpkg/dev-deprecated/store-BX7GvXC_.js.map +1 -0
  217. package/dist/unpkg/dev-deprecated/store.js +1 -635
  218. package/dist/unpkg/dev-deprecated/util-9mgEBJ3W.js +18 -0
  219. package/dist/unpkg/dev-deprecated/util-9mgEBJ3W.js.map +1 -0
  220. package/dist/unpkg/dev-deprecated/utils-Cl86-e7F.js +17 -0
  221. package/dist/unpkg/dev-deprecated/utils-Cl86-e7F.js.map +1 -0
  222. package/dist/unpkg/prod/-private-B4bxoTuK.js +160 -0
  223. package/dist/unpkg/prod/-private-B4bxoTuK.js.map +1 -0
  224. package/dist/unpkg/prod/-private-SfXkkHKd.js +745 -0
  225. package/dist/unpkg/prod/-private-SfXkkHKd.js.map +1 -0
  226. package/dist/unpkg/prod/adapter/-private.js +3 -1
  227. package/dist/unpkg/prod/adapter/error.js +421 -305
  228. package/dist/unpkg/prod/adapter/error.js.map +1 -0
  229. package/dist/unpkg/prod/adapter/json-api.js +236 -240
  230. package/dist/unpkg/prod/adapter/json-api.js.map +1 -0
  231. package/dist/unpkg/prod/adapter/rest.js +911 -1061
  232. package/dist/unpkg/prod/adapter/rest.js.map +1 -0
  233. package/dist/unpkg/prod/adapter-DQ9UA7FC.js +1111 -0
  234. package/dist/unpkg/prod/adapter-DQ9UA7FC.js.map +1 -0
  235. package/dist/unpkg/prod/adapter.js +1 -1217
  236. package/dist/unpkg/prod/compat/-private.js +3 -1
  237. package/dist/unpkg/prod/compat/builders.js +165 -183
  238. package/dist/unpkg/prod/compat/builders.js.map +1 -0
  239. package/dist/unpkg/prod/compat/extensions.js +258 -222
  240. package/dist/unpkg/prod/compat/extensions.js.map +1 -0
  241. package/dist/unpkg/prod/compat/utils.js +185 -188
  242. package/dist/unpkg/prod/compat/utils.js.map +1 -0
  243. package/dist/unpkg/prod/compat-DxiVkCUb.js +547 -0
  244. package/dist/unpkg/prod/compat-DxiVkCUb.js.map +1 -0
  245. package/dist/unpkg/prod/compat.js +1 -725
  246. package/dist/unpkg/prod/errors-CVXWrUjP.js +1977 -0
  247. package/dist/unpkg/prod/errors-CVXWrUjP.js.map +1 -0
  248. package/dist/unpkg/prod/index.js +249 -146
  249. package/dist/unpkg/prod/index.js.map +1 -0
  250. package/dist/unpkg/prod/json-BD1kRTfB.js +1080 -0
  251. package/dist/unpkg/prod/json-BD1kRTfB.js.map +1 -0
  252. package/dist/unpkg/prod/model/-private.js +3 -1
  253. package/dist/unpkg/prod/model/migration-support.js +479 -530
  254. package/dist/unpkg/prod/model/migration-support.js.map +1 -0
  255. package/dist/unpkg/prod/model-D3WMsNNE.js +603 -0
  256. package/dist/unpkg/prod/model-D3WMsNNE.js.map +1 -0
  257. package/dist/unpkg/prod/model-fragments-DSqu0ptR.js +334 -0
  258. package/dist/unpkg/prod/model-fragments-DSqu0ptR.js.map +1 -0
  259. package/dist/unpkg/prod/model-fragments.js +2 -75
  260. package/dist/unpkg/prod/model.js +3 -592
  261. package/dist/unpkg/prod/runtime--fcdnjmJ-DMTJ0Kb3.js +53 -0
  262. package/dist/unpkg/prod/runtime--fcdnjmJ-DMTJ0Kb3.js.map +1 -0
  263. package/dist/unpkg/prod/schema-provider-_pimTZ3P.js +1622 -0
  264. package/dist/unpkg/prod/schema-provider-_pimTZ3P.js.map +1 -0
  265. package/dist/unpkg/prod/serializer/json-api.js +497 -587
  266. package/dist/unpkg/prod/serializer/json-api.js.map +1 -0
  267. package/dist/unpkg/prod/serializer/json.js +3 -4
  268. package/dist/unpkg/prod/serializer/rest.js +938 -1167
  269. package/dist/unpkg/prod/serializer/rest.js.map +1 -0
  270. package/dist/unpkg/prod/serializer/transform.js +283 -260
  271. package/dist/unpkg/prod/serializer/transform.js.map +1 -0
  272. package/dist/unpkg/prod/serializer.js +205 -208
  273. package/dist/unpkg/prod/serializer.js.map +1 -0
  274. package/dist/unpkg/prod/store-RGGc1ilN.js +392 -0
  275. package/dist/unpkg/prod/store-RGGc1ilN.js.map +1 -0
  276. package/dist/unpkg/prod/store.js +1 -503
  277. package/dist/unpkg/prod/util-dSKEgQDp.js +12 -0
  278. package/dist/unpkg/prod/util-dSKEgQDp.js.map +1 -0
  279. package/dist/unpkg/prod/utils-DYC9utVJ.js +11 -0
  280. package/dist/unpkg/prod/utils-DYC9utVJ.js.map +1 -0
  281. package/dist/unpkg/prod-deprecated/-private-B4bxoTuK.js +160 -0
  282. package/dist/unpkg/prod-deprecated/-private-B4bxoTuK.js.map +1 -0
  283. package/dist/unpkg/prod-deprecated/-private-SfXkkHKd.js +745 -0
  284. package/dist/unpkg/prod-deprecated/-private-SfXkkHKd.js.map +1 -0
  285. package/dist/unpkg/prod-deprecated/adapter/-private.js +3 -1
  286. package/dist/unpkg/prod-deprecated/adapter/error.js +421 -305
  287. package/dist/unpkg/prod-deprecated/adapter/error.js.map +1 -0
  288. package/dist/unpkg/prod-deprecated/adapter/json-api.js +236 -240
  289. package/dist/unpkg/prod-deprecated/adapter/json-api.js.map +1 -0
  290. package/dist/unpkg/prod-deprecated/adapter/rest.js +911 -1061
  291. package/dist/unpkg/prod-deprecated/adapter/rest.js.map +1 -0
  292. package/{declarations/adapter.d.ts → dist/unpkg/prod-deprecated/adapter-DQ9UA7FC.js} +451 -110
  293. package/dist/unpkg/prod-deprecated/adapter-DQ9UA7FC.js.map +1 -0
  294. package/dist/unpkg/prod-deprecated/adapter.js +1 -1217
  295. package/dist/unpkg/prod-deprecated/compat/-private.js +3 -1
  296. package/dist/unpkg/prod-deprecated/compat/builders.js +165 -183
  297. package/dist/unpkg/prod-deprecated/compat/builders.js.map +1 -0
  298. package/dist/unpkg/prod-deprecated/compat/extensions.js +258 -222
  299. package/dist/unpkg/prod-deprecated/compat/extensions.js.map +1 -0
  300. package/dist/unpkg/prod-deprecated/compat/utils.js +185 -188
  301. package/dist/unpkg/prod-deprecated/compat/utils.js.map +1 -0
  302. package/dist/unpkg/prod-deprecated/compat-DxiVkCUb.js +547 -0
  303. package/dist/unpkg/prod-deprecated/compat-DxiVkCUb.js.map +1 -0
  304. package/dist/unpkg/prod-deprecated/compat.js +1 -725
  305. package/dist/unpkg/prod-deprecated/errors-9LXqpfRd.js +1978 -0
  306. package/dist/unpkg/prod-deprecated/errors-9LXqpfRd.js.map +1 -0
  307. package/dist/unpkg/prod-deprecated/index.js +249 -145
  308. package/dist/unpkg/prod-deprecated/index.js.map +1 -0
  309. package/dist/unpkg/prod-deprecated/json-BD1kRTfB.js +1080 -0
  310. package/dist/unpkg/prod-deprecated/json-BD1kRTfB.js.map +1 -0
  311. package/dist/unpkg/prod-deprecated/model/-private.js +3 -1
  312. package/dist/unpkg/prod-deprecated/model/migration-support.js +490 -547
  313. package/dist/unpkg/prod-deprecated/model/migration-support.js.map +1 -0
  314. package/dist/unpkg/prod-deprecated/model-aiVrr1fz.js +604 -0
  315. package/dist/unpkg/prod-deprecated/model-aiVrr1fz.js.map +1 -0
  316. package/dist/unpkg/prod-deprecated/model-fragments-DSqu0ptR.js +334 -0
  317. package/dist/unpkg/prod-deprecated/model-fragments-DSqu0ptR.js.map +1 -0
  318. package/dist/unpkg/prod-deprecated/model-fragments.js +2 -75
  319. package/dist/unpkg/prod-deprecated/model.js +3 -595
  320. package/dist/unpkg/prod-deprecated/runtime--fcdnjmJ-DMTJ0Kb3.js +53 -0
  321. package/dist/unpkg/prod-deprecated/runtime--fcdnjmJ-DMTJ0Kb3.js.map +1 -0
  322. package/dist/unpkg/prod-deprecated/schema-provider-DyfSd9Cv.js +1635 -0
  323. package/dist/unpkg/prod-deprecated/schema-provider-DyfSd9Cv.js.map +1 -0
  324. package/dist/unpkg/prod-deprecated/serializer/json-api.js +497 -587
  325. package/dist/unpkg/prod-deprecated/serializer/json-api.js.map +1 -0
  326. package/dist/unpkg/prod-deprecated/serializer/json.js +3 -4
  327. package/dist/unpkg/prod-deprecated/serializer/rest.js +938 -1167
  328. package/dist/unpkg/prod-deprecated/serializer/rest.js.map +1 -0
  329. package/dist/unpkg/prod-deprecated/serializer/transform.js +283 -260
  330. package/dist/unpkg/prod-deprecated/serializer/transform.js.map +1 -0
  331. package/dist/unpkg/prod-deprecated/serializer.js +205 -208
  332. package/dist/unpkg/prod-deprecated/serializer.js.map +1 -0
  333. package/dist/unpkg/prod-deprecated/store-0L2CkYzh.js +392 -0
  334. package/dist/unpkg/prod-deprecated/store-0L2CkYzh.js.map +1 -0
  335. package/dist/unpkg/prod-deprecated/store.js +1 -503
  336. package/dist/unpkg/prod-deprecated/util-CQQdHX3n.js +14 -0
  337. package/dist/unpkg/prod-deprecated/util-CQQdHX3n.js.map +1 -0
  338. package/dist/unpkg/prod-deprecated/utils-BMI_JwFP.js +13 -0
  339. package/dist/unpkg/prod-deprecated/utils-BMI_JwFP.js.map +1 -0
  340. package/dist/util-Bnx8nm-D.js +29 -0
  341. package/dist/util-Bnx8nm-D.js.map +1 -0
  342. package/dist/utils-ZAytYep8.js +28 -0
  343. package/dist/utils-ZAytYep8.js.map +1 -0
  344. package/package.json +21 -25
  345. package/declarations/adapter/-private/build-url-mixin.d.ts +0 -33
  346. package/declarations/adapter/-private/fastboot-interface.d.ts +0 -8
  347. package/declarations/adapter/-private/utils/continue-on-reject.d.ts +0 -1
  348. package/declarations/adapter/-private/utils/determine-body-promise.d.ts +0 -4
  349. package/declarations/adapter/-private/utils/fetch.d.ts +0 -8
  350. package/declarations/adapter/-private/utils/parse-response-headers.d.ts +0 -1
  351. package/declarations/adapter/-private/utils/serialize-into-hash.d.ts +0 -6
  352. package/declarations/adapter/-private/utils/serialize-query-params.d.ts +0 -5
  353. package/declarations/adapter/-private.d.ts +0 -5
  354. package/declarations/adapter/error.d.ts +0 -215
  355. package/declarations/compat/-private.d.ts +0 -13
  356. package/declarations/compat/builders/find-all.d.ts +0 -35
  357. package/declarations/compat/builders/find-record.d.ts +0 -56
  358. package/declarations/compat/builders/query.d.ts +0 -66
  359. package/declarations/compat/builders/save-record.d.ts +0 -34
  360. package/declarations/compat/builders/utils.d.ts +0 -3
  361. package/declarations/compat/builders.d.ts +0 -14
  362. package/declarations/compat/extensions.d.ts +0 -59
  363. package/declarations/compat/legacy-network-handler/fetch-manager.d.ts +0 -55
  364. package/declarations/compat/legacy-network-handler/identifier-has-id.d.ts +0 -2
  365. package/declarations/compat/legacy-network-handler/legacy-data-fetch.d.ts +0 -11
  366. package/declarations/compat/legacy-network-handler/legacy-data-utils.d.ts +0 -5
  367. package/declarations/compat/legacy-network-handler/legacy-network-handler.d.ts +0 -2
  368. package/declarations/compat/legacy-network-handler/minimum-adapter-interface.d.ts +0 -524
  369. package/declarations/compat/legacy-network-handler/minimum-serializer-interface.d.ts +0 -213
  370. package/declarations/compat/legacy-network-handler/serializer-response.d.ts +0 -6
  371. package/declarations/compat/legacy-network-handler/snapshot-record-array.d.ts +0 -110
  372. package/declarations/compat/legacy-network-handler/snapshot.d.ts +0 -255
  373. package/declarations/compat/utils.d.ts +0 -137
  374. package/declarations/compat.d.ts +0 -157
  375. package/declarations/index.d.ts +0 -102
  376. package/declarations/model/-private/attr.d.ts +0 -170
  377. package/declarations/model/-private/belongs-to.d.ts +0 -174
  378. package/declarations/model/-private/debug/assert-polymorphic-type.d.ts +0 -5
  379. package/declarations/model/-private/errors.d.ts +0 -289
  380. package/declarations/model/-private/has-many.d.ts +0 -162
  381. package/declarations/model/-private/hooks.d.ts +0 -10
  382. package/declarations/model/-private/legacy-relationships-support.d.ts +0 -47
  383. package/declarations/model/-private/model-for-mixin.d.ts +0 -3
  384. package/declarations/model/-private/model-methods.d.ts +0 -39
  385. package/declarations/model/-private/model.d.ts +0 -1228
  386. package/declarations/model/-private/notify-changes.d.ts +0 -4
  387. package/declarations/model/-private/promise-belongs-to.d.ts +0 -40
  388. package/declarations/model/-private/promise-many-array.d.ts +0 -106
  389. package/declarations/model/-private/record-state.d.ts +0 -58
  390. package/declarations/model/-private/references/belongs-to.d.ts +0 -488
  391. package/declarations/model/-private/references/has-many.d.ts +0 -498
  392. package/declarations/model/-private/schema-provider.d.ts +0 -56
  393. package/declarations/model/-private/type-utils.d.ts +0 -57
  394. package/declarations/model/-private/util.d.ts +0 -5
  395. package/declarations/model/-private.d.ts +0 -8
  396. package/declarations/model/migration-support.d.ts +0 -280
  397. package/declarations/model-fragments/extensions/fragment-array.d.ts +0 -16
  398. package/declarations/model-fragments/extensions/fragment.d.ts +0 -15
  399. package/declarations/model-fragments/hooks/model-for.d.ts +0 -20
  400. package/declarations/model-fragments/index.d.ts +0 -5
  401. package/declarations/model-fragments/instance-initializers/fragment-extensions.d.ts +0 -9
  402. package/declarations/model-fragments/utilities/with-array-defaults.d.ts +0 -15
  403. package/declarations/model-fragments/utilities/with-fragment-array-defaults.d.ts +0 -20
  404. package/declarations/model-fragments/utilities/with-fragment-defaults.d.ts +0 -19
  405. package/declarations/model-fragments/utilities/with-legacy.d.ts +0 -3
  406. package/declarations/model-fragments.d.ts +0 -9
  407. package/declarations/model.d.ts +0 -49
  408. package/declarations/serializer/-private/transforms/boolean.d.ts +0 -47
  409. package/declarations/serializer/-private/transforms/date.d.ts +0 -28
  410. package/declarations/serializer/-private/transforms/number.d.ts +0 -29
  411. package/declarations/serializer/-private/transforms/string.d.ts +0 -29
  412. package/declarations/serializer/-private/transforms/transform.d.ts +0 -118
  413. package/declarations/serializer/-private/utils.d.ts +0 -3
  414. package/declarations/serializer/rest.d.ts +0 -51
  415. package/declarations/serializer/transform.d.ts +0 -5
  416. package/declarations/serializer.d.ts +0 -254
  417. package/declarations/store/-private.d.ts +0 -223
  418. package/declarations/store.d.ts +0 -3
  419. package/dist/-private-BG3bMiKp.js +0 -1211
  420. package/dist/errors-Cz5KrzBk.js +0 -2566
  421. package/dist/hooks-D6diaM34.js +0 -74
  422. package/dist/json-ChdEfB0X.js +0 -1259
  423. package/dist/model-for-CqXsIKws.js +0 -221
  424. package/dist/runtime-BPCpkOf1-BKOwiRJp.js +0 -65
  425. package/dist/schema-provider-DJCV_6AF.js +0 -2295
  426. package/dist/serialize-into-hash-DPZYoF-i.js +0 -261
  427. package/dist/unpkg/dev/-private-DtjBbEgy.js +0 -1206
  428. package/dist/unpkg/dev/errors-DmGGJr3T.js +0 -2562
  429. package/dist/unpkg/dev/hooks-CkYiE6Ud.js +0 -73
  430. package/dist/unpkg/dev/json-Cu1LNgmQ.js +0 -1256
  431. package/dist/unpkg/dev/model-for-CqXsIKws.js +0 -221
  432. package/dist/unpkg/dev/runtime-BPCpkOf1-BKOwiRJp.js +0 -65
  433. package/dist/unpkg/dev/schema-provider-DDVYxmUV.js +0 -2186
  434. package/dist/unpkg/dev/serialize-into-hash-B2xDbuo5.js +0 -259
  435. package/dist/unpkg/dev/util-DvanW33H.js +0 -20
  436. package/dist/unpkg/dev/utils-BhvS1iTS.js +0 -8
  437. package/dist/unpkg/dev-deprecated/-private-DtjBbEgy.js +0 -1206
  438. package/dist/unpkg/dev-deprecated/errors-Spt6ubMd.js +0 -2565
  439. package/dist/unpkg/dev-deprecated/hooks-DOXegvhL.js +0 -73
  440. package/dist/unpkg/dev-deprecated/json-Cu1LNgmQ.js +0 -1256
  441. package/dist/unpkg/dev-deprecated/model-for-CqXsIKws.js +0 -221
  442. package/dist/unpkg/dev-deprecated/runtime-BPCpkOf1-BKOwiRJp.js +0 -65
  443. package/dist/unpkg/dev-deprecated/schema-provider-BP6_8N-V.js +0 -2211
  444. package/dist/unpkg/dev-deprecated/serialize-into-hash-B2xDbuo5.js +0 -259
  445. package/dist/unpkg/dev-deprecated/util-CWr5WQOT.js +0 -24
  446. package/dist/unpkg/dev-deprecated/utils-C9PJehtL.js +0 -12
  447. package/dist/unpkg/prod/-private-BdyZaGEh.js +0 -971
  448. package/dist/unpkg/prod/errors-BGVFCBmi.js +0 -2314
  449. package/dist/unpkg/prod/hooks-BztVA_x0.js +0 -41
  450. package/dist/unpkg/prod/json-BWrZ5546.js +0 -1243
  451. package/dist/unpkg/prod/model-for-CqXsIKws.js +0 -221
  452. package/dist/unpkg/prod/runtime-BPCpkOf1-BKOwiRJp.js +0 -65
  453. package/dist/unpkg/prod/schema-provider-DJtD_8jZ.js +0 -1861
  454. package/dist/unpkg/prod/serialize-into-hash-DGlzQteF.js +0 -215
  455. package/dist/unpkg/prod/util-DvanW33H.js +0 -20
  456. package/dist/unpkg/prod/utils-BhvS1iTS.js +0 -8
  457. package/dist/unpkg/prod-deprecated/-private-BdyZaGEh.js +0 -971
  458. package/dist/unpkg/prod-deprecated/errors-CdDaK81x.js +0 -2317
  459. package/dist/unpkg/prod-deprecated/hooks-yId87yyG.js +0 -41
  460. package/dist/unpkg/prod-deprecated/json-BWrZ5546.js +0 -1243
  461. package/dist/unpkg/prod-deprecated/model-for-CqXsIKws.js +0 -221
  462. package/dist/unpkg/prod-deprecated/runtime-BPCpkOf1-BKOwiRJp.js +0 -65
  463. package/dist/unpkg/prod-deprecated/schema-provider-CjX55uSY.js +0 -1904
  464. package/dist/unpkg/prod-deprecated/serialize-into-hash-DGlzQteF.js +0 -215
  465. package/dist/unpkg/prod-deprecated/util-B6cn-i93.js +0 -23
  466. package/dist/unpkg/prod-deprecated/utils-BUWwQwCh.js +0 -11
  467. package/dist/util-Dul6TZts.js +0 -35
  468. package/dist/utils-Cqw9eRj5.js +0 -23
@@ -1,1243 +1,1001 @@
1
- import { warn } from '@ember/debug';
2
- import { camelize, dasherize, singularize } from '@warp-drive/utilities/string';
3
- import { J as JSONSerializer, c as coerceId } from "../json-ChdEfB0X.js";
4
- import { macroCondition, getGlobalConfig } from '@embroider/macros';
5
- import Mixin from '@ember/object/mixin';
6
-
7
- /* eslint-disable @typescript-eslint/no-unsafe-argument */
8
- /* eslint-disable @typescript-eslint/no-unsafe-return */
9
- /* eslint-disable @typescript-eslint/no-unsafe-call */
10
- /* eslint-disable @typescript-eslint/no-unsafe-member-access */
11
- /* eslint-disable @typescript-eslint/no-unsafe-assignment */
1
+ import { n as coerceId, r as inverseForRelationship, t as JSONSerializer } from "../json-BXNPTlcH.js";
2
+ import { warn } from "@ember/debug";
3
+ import { getGlobalConfig, macroCondition } from "@embroider/macros";
4
+ import { camelize, dasherize, singularize } from "@warp-drive/utilities/string";
5
+ import Mixin from "@ember/object/mixin";
12
6
 
7
+ //#region src/serializer/-private/embedded-records-mixin.ts
13
8
  /**
14
- ## Using Embedded Records
15
-
16
- `EmbeddedRecordsMixin` supports serializing embedded records.
17
-
18
- To set up embedded records, include the mixin when extending a serializer,
19
- then define and configure embedded (model) relationships.
9
+ ## Using Embedded Records
20
10
 
21
- Note that embedded records will serialize with the serializer for their model instead of the serializer in which they are defined.
11
+ `EmbeddedRecordsMixin` supports serializing embedded records.
22
12
 
23
- Note also that this mixin does not work with JSONAPISerializer because the JSON:API specification does not describe how to format embedded resources.
13
+ To set up embedded records, include the mixin when extending a serializer,
14
+ then define and configure embedded (model) relationships.
24
15
 
25
- Below is an example of a per-type serializer (`post` type).
16
+ Note that embedded records will serialize with the serializer for their model instead of the serializer in which they are defined.
26
17
 
27
- ```js [app/serializers/post.js]
28
- import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
18
+ Note also that this mixin does not work with JSONAPISerializer because the JSON:API specification does not describe how to format embedded resources.
29
19
 
30
- export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
31
- attrs = {
32
- author: { embedded: 'always' },
33
- comments: { serialize: 'ids' }
34
- }
35
- }
36
- ```
37
- Note that this use of `{ embedded: 'always' }` is unrelated to
38
- the `{ embedded: 'always' }` that is defined as an option on `attr` as part of
39
- defining a model while working with the `ActiveModelSerializer`. Nevertheless,
40
- using `{ embedded: 'always' }` as an option to `attr` is not a valid way to set up
41
- embedded records.
20
+ Below is an example of a per-type serializer (`post` type).
42
21
 
43
- The `attrs` option for a resource `{ embedded: 'always' }` is shorthand for:
22
+ ```js [app/serializers/post.js]
23
+ import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
44
24
 
45
- ```js
46
- {
47
- serialize: 'records',
48
- deserialize: 'records'
49
- }
50
- ```
25
+ export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
26
+ attrs = {
27
+ author: { embedded: 'always' },
28
+ comments: { serialize: 'ids' }
29
+ }
30
+ }
31
+ ```
32
+ Note that this use of `{ embedded: 'always' }` is unrelated to
33
+ the `{ embedded: 'always' }` that is defined as an option on `attr` as part of
34
+ defining a model while working with the `ActiveModelSerializer`. Nevertheless,
35
+ using `{ embedded: 'always' }` as an option to `attr` is not a valid way to set up
36
+ embedded records.
37
+
38
+ The `attrs` option for a resource `{ embedded: 'always' }` is shorthand for:
39
+
40
+ ```js
41
+ {
42
+ serialize: 'records',
43
+ deserialize: 'records'
44
+ }
45
+ ```
51
46
 
52
- ### Configuring Attrs
47
+ ### Configuring Attrs
53
48
 
54
- A resource's `attrs` option may be set to use `ids`, `records` or false for the
55
- `serialize` and `deserialize` settings.
49
+ A resource's `attrs` option may be set to use `ids`, `records` or false for the
50
+ `serialize` and `deserialize` settings.
56
51
 
57
- The `attrs` property can be set on the `ApplicationSerializer` or a per-type
58
- serializer.
52
+ The `attrs` property can be set on the `ApplicationSerializer` or a per-type
53
+ serializer.
59
54
 
60
- In the case where embedded JSON is expected while extracting a payload (reading)
61
- the setting is `deserialize: 'records'`, there is no need to use `ids` when
62
- extracting as that is the default behaviour without this mixin if you are using
63
- the vanilla `EmbeddedRecordsMixin`. Likewise, to embed JSON in the payload while
64
- serializing `serialize: 'records'` is the setting to use. There is an option of
65
- not embedding JSON in the serialized payload by using `serialize: 'ids'`. If you
66
- do not want the relationship sent at all, you can use `serialize: false`.
55
+ In the case where embedded JSON is expected while extracting a payload (reading)
56
+ the setting is `deserialize: 'records'`, there is no need to use `ids` when
57
+ extracting as that is the default behaviour without this mixin if you are using
58
+ the vanilla `EmbeddedRecordsMixin`. Likewise, to embed JSON in the payload while
59
+ serializing `serialize: 'records'` is the setting to use. There is an option of
60
+ not embedding JSON in the serialized payload by using `serialize: 'ids'`. If you
61
+ do not want the relationship sent at all, you can use `serialize: false`.
67
62
 
68
63
 
69
- ### EmbeddedRecordsMixin defaults
70
- If you do not overwrite `attrs` for a specific relationship, the `EmbeddedRecordsMixin`
71
- will behave in the following way:
64
+ ### EmbeddedRecordsMixin defaults
65
+ If you do not overwrite `attrs` for a specific relationship, the `EmbeddedRecordsMixin`
66
+ will behave in the following way:
72
67
 
73
- BelongsTo: `{ serialize: 'id', deserialize: 'id' }`
74
- HasMany: `{ serialize: false, deserialize: 'ids' }`
68
+ BelongsTo: `{ serialize: 'id', deserialize: 'id' }`
69
+ HasMany: `{ serialize: false, deserialize: 'ids' }`
75
70
 
76
- ### Model Relationships
71
+ ### Model Relationships
77
72
 
78
- Embedded records must have a model defined to be extracted and serialized. Note that
79
- when defining any relationships on your model such as `belongsTo` and `hasMany`, you
80
- should not both specify `async: true` and also indicate through the serializer's
81
- `attrs` attribute that the related model should be embedded for deserialization.
82
- If a model is declared embedded for deserialization (`embedded: 'always'` or `deserialize: 'records'`),
83
- then do not use `async: true`.
73
+ Embedded records must have a model defined to be extracted and serialized. Note that
74
+ when defining any relationships on your model such as `belongsTo` and `hasMany`, you
75
+ should not both specify `async: true` and also indicate through the serializer's
76
+ `attrs` attribute that the related model should be embedded for deserialization.
77
+ If a model is declared embedded for deserialization (`embedded: 'always'` or `deserialize: 'records'`),
78
+ then do not use `async: true`.
84
79
 
85
- To successfully extract and serialize embedded records the model relationships
86
- must be set up correctly. See the
87
- [defining relationships](https://guides.emberjs.com/current/models/relationships)
88
- section of the **Defining Models** guide page.
80
+ To successfully extract and serialize embedded records the model relationships
81
+ must be set up correctly. See the
82
+ [defining relationships](https://guides.emberjs.com/current/models/relationships)
83
+ section of the **Defining Models** guide page.
89
84
 
90
- Records without an `id` property are not considered embedded records, model
91
- instances must have an `id` property to be used with Ember Data.
85
+ Records without an `id` property are not considered embedded records, model
86
+ instances must have an `id` property to be used with Ember Data.
92
87
 
93
- ### Example JSON payloads, Models and Serializers
88
+ ### Example JSON payloads, Models and Serializers
94
89
 
95
- **When customizing a serializer it is important to grok what the customizations
96
- are. Please read the docs for the methods this mixin provides, in case you need
97
- to modify it to fit your specific needs.**
90
+ **When customizing a serializer it is important to grok what the customizations
91
+ are. Please read the docs for the methods this mixin provides, in case you need
92
+ to modify it to fit your specific needs.**
98
93
 
99
- @class EmbeddedRecordsMixin
100
- @public
94
+ @class EmbeddedRecordsMixin
95
+ @public
101
96
  */
102
97
  const EmbeddedRecordsMixin = Mixin.create({
103
- /**
104
- Normalize the record and recursively normalize/extract all the embedded records
105
- while pushing them into the store as they are encountered
106
- A payload with an attr configured for embedded records needs to be extracted:
107
- ```js
108
- {
109
- "post": {
110
- "id": "1"
111
- "title": "Rails is omakase",
112
- "comments": [{
113
- "id": "1",
114
- "body": "Rails is unagi"
115
- }, {
116
- "id": "2",
117
- "body": "Omakase O_o"
118
- }]
119
- }
120
- }
121
- ```
122
- @public
123
- @param {Model} typeClass
124
- @param {Object} hash to be normalized
125
- @param {String} prop the hash has been referenced by
126
- @return {Object} the normalized hash
127
- **/
128
- normalize(typeClass, hash, prop) {
129
- const normalizedHash = this._super(typeClass, hash, prop);
130
- return this._extractEmbeddedRecords(this, this.store, typeClass, normalizedHash);
131
- },
132
- keyForRelationship(key, typeClass, method) {
133
- if (method === 'serialize' && this.hasSerializeRecordsOption(key) || method === 'deserialize' && this.hasDeserializeRecordsOption(key)) {
134
- return this.keyForAttribute(key, method);
135
- } else {
136
- return this._super(key, typeClass, method) || key;
137
- }
138
- },
139
- /**
140
- Serialize `belongsTo` relationship when it is configured as an embedded object.
141
- This example of an author model belongs to a post model:
142
- ```js
143
- import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
144
- Post = Model.extend({
145
- title: attr('string'),
146
- body: attr('string'),
147
- author: belongsTo('author')
148
- });
149
- Author = Model.extend({
150
- name: attr('string'),
151
- post: belongsTo('post')
152
- });
153
- ```
154
- Use a custom (type) serializer for the post model to configure embedded author
155
- ```js [app/serializers/post.js]
156
- import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
157
- export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
158
- attrs = {
159
- author: { embedded: 'always' }
160
- }
161
- }
162
- ```
163
- A payload with an attribute configured for embedded records can serialize
164
- the records together under the root attribute's payload:
165
- ```js
166
- {
167
- "post": {
168
- "id": "1"
169
- "title": "Rails is omakase",
170
- "author": {
171
- "id": "2"
172
- "name": "dhh"
173
- }
174
- }
175
- }
176
- ```
177
- @public
178
- @param {Snapshot} snapshot
179
- @param {Object} json
180
- @param {Object} relationship
181
- */
182
- serializeBelongsTo(snapshot, json, relationship) {
183
- const attr = relationship.name;
184
- if (this.noSerializeOptionSpecified(attr)) {
185
- this._super(snapshot, json, relationship);
186
- return;
187
- }
188
- const includeIds = this.hasSerializeIdsOption(attr);
189
- const includeRecords = this.hasSerializeRecordsOption(attr);
190
- const embeddedSnapshot = snapshot.belongsTo(attr);
191
- if (includeIds) {
192
- const schema = this.store.modelFor(snapshot.modelName);
193
- let serializedKey = this._getMappedKey(relationship.name, schema);
194
- if (serializedKey === relationship.name && this.keyForRelationship) {
195
- serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
196
- }
197
- if (!embeddedSnapshot) {
198
- json[serializedKey] = null;
199
- } else {
200
- json[serializedKey] = embeddedSnapshot.id;
201
- if (relationship.options.polymorphic) {
202
- this.serializePolymorphicType(snapshot, json, relationship);
203
- }
204
- }
205
- } else if (includeRecords) {
206
- this._serializeEmbeddedBelongsTo(snapshot, json, relationship);
207
- }
208
- },
209
- _serializeEmbeddedBelongsTo(snapshot, json, relationship) {
210
- const embeddedSnapshot = snapshot.belongsTo(relationship.name);
211
- const schema = this.store.modelFor(snapshot.modelName);
212
- let serializedKey = this._getMappedKey(relationship.name, schema);
213
- if (serializedKey === relationship.name && this.keyForRelationship) {
214
- serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
215
- }
216
- if (!embeddedSnapshot) {
217
- json[serializedKey] = null;
218
- } else {
219
- json[serializedKey] = embeddedSnapshot.serialize({
220
- includeId: true
221
- });
222
- this.removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, json[serializedKey]);
223
- if (relationship.options.polymorphic) {
224
- this.serializePolymorphicType(snapshot, json, relationship);
225
- }
226
- }
227
- },
228
- /**
229
- Serializes `hasMany` relationships when it is configured as embedded objects.
230
- This example of a post model has many comments:
231
- ```js
232
- import Model, { attr, belongsTo, hasMany } from '@warp-drive/legacy/model';
233
- Post = Model.extend({
234
- title: attr('string'),
235
- body: attr('string'),
236
- comments: hasMany('comment')
237
- });
238
- Comment = Model.extend({
239
- body: attr('string'),
240
- post: belongsTo('post')
241
- });
242
- ```
243
- Use a custom (type) serializer for the post model to configure embedded comments
244
- ```js [app/serializers/post.js]
245
- import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
246
- export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
247
- attrs = {
248
- comments: { embedded: 'always' }
249
- }
250
- }
251
- ```
252
- A payload with an attribute configured for embedded records can serialize
253
- the records together under the root attribute's payload:
254
- ```js
255
- {
256
- "post": {
257
- "id": "1"
258
- "title": "Rails is omakase",
259
- "body": "I want this for my ORM, I want that for my template language..."
260
- "comments": [{
261
- "id": "1",
262
- "body": "Rails is unagi"
263
- }, {
264
- "id": "2",
265
- "body": "Omakase O_o"
266
- }]
267
- }
268
- }
269
- ```
270
- The attrs options object can use more specific instruction for extracting and
271
- serializing. When serializing, an option to embed `ids`, `ids-and-types` or `records` can be set.
272
- When extracting the only option is `records`.
273
- So `{ embedded: 'always' }` is shorthand for:
274
- `{ serialize: 'records', deserialize: 'records' }`
275
- To embed the `ids` for a related object (using a hasMany relationship):
276
- ```js [app/serializers/post.js]
277
- import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
278
- export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
279
- attrs = {
280
- comments: { serialize: 'ids', deserialize: 'records' }
281
- }
282
- }
283
- ```
284
- ```js
285
- {
286
- "post": {
287
- "id": "1"
288
- "title": "Rails is omakase",
289
- "body": "I want this for my ORM, I want that for my template language..."
290
- "comments": ["1", "2"]
291
- }
292
- }
293
- ```
294
- To embed the relationship as a collection of objects with `id` and `type` keys, set
295
- `ids-and-types` for the related object.
296
- This is particularly useful for polymorphic relationships where records don't share
297
- the same table and the `id` is not enough information.
298
- For example having a user that has many pets:
299
- ```js
300
- User = Model.extend({
301
- name: attr('string'),
302
- pets: hasMany('pet', { polymorphic: true })
303
- });
304
- Pet = Model.extend({
305
- name: attr('string'),
306
- });
307
- Cat = Pet.extend({
308
- // ...
309
- });
310
- Parrot = Pet.extend({
311
- // ...
312
- });
313
- ```
314
- ```js [app/serializers/user.js]
315
- import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
316
- export default class UserSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
317
- attrs = {
318
- pets: { serialize: 'ids-and-types', deserialize: 'records' }
319
- }
320
- }
321
- ```
322
- ```js
323
- {
324
- "user": {
325
- "id": "1"
326
- "name": "Bertin Osborne",
327
- "pets": [
328
- { "id": "1", "type": "Cat" },
329
- { "id": "1", "type": "Parrot"}
330
- ]
331
- }
332
- }
333
- ```
334
- @public
335
- @param {Snapshot} snapshot
336
- @param {Object} json
337
- @param {Object} relationship
338
- */
339
- serializeHasMany(snapshot, json, relationship) {
340
- const attr = relationship.name;
341
- if (this.noSerializeOptionSpecified(attr)) {
342
- this._super(snapshot, json, relationship);
343
- return;
344
- }
345
- if (this.hasSerializeIdsOption(attr)) {
346
- const schema = this.store.modelFor(snapshot.modelName);
347
- let serializedKey = this._getMappedKey(relationship.name, schema);
348
- if (serializedKey === relationship.name && this.keyForRelationship) {
349
- serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
350
- }
351
- json[serializedKey] = snapshot.hasMany(attr, {
352
- ids: true
353
- });
354
- } else if (this.hasSerializeRecordsOption(attr)) {
355
- this._serializeEmbeddedHasMany(snapshot, json, relationship);
356
- } else {
357
- if (this.hasSerializeIdsAndTypesOption(attr)) {
358
- this._serializeHasManyAsIdsAndTypes(snapshot, json, relationship);
359
- }
360
- }
361
- },
362
- /*
363
- Serializes a hasMany relationship as an array of objects containing only `id` and `type`
364
- keys.
365
- This has its use case on polymorphic hasMany relationships where the server is not storing
366
- all records in the same table using STI, and therefore the `id` is not enough information
367
- TODO: Make the default in Ember-data 3.0??
368
- */
369
- _serializeHasManyAsIdsAndTypes(snapshot, json, relationship) {
370
- const serializedKey = this.keyForAttribute(relationship.name, 'serialize');
371
- const hasMany = snapshot.hasMany(relationship.name) || [];
372
- json[serializedKey] = hasMany.map(function (recordSnapshot) {
373
- //
374
- // I'm sure I'm being utterly naive here. Probably id is a configurable property and
375
- // type too, and the modelName has to be normalized somehow.
376
- //
377
- return {
378
- id: recordSnapshot.id,
379
- type: recordSnapshot.modelName
380
- };
381
- });
382
- },
383
- _serializeEmbeddedHasMany(snapshot, json, relationship) {
384
- const schema = this.store.modelFor(snapshot.modelName);
385
- let serializedKey = this._getMappedKey(relationship.name, schema);
386
- if (serializedKey === relationship.name && this.keyForRelationship) {
387
- serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
388
- }
389
- warn(`The embedded relationship '${serializedKey}' is undefined for '${snapshot.modelName}' with id '${snapshot.id}'. Please include it in your original payload.`, typeof snapshot.hasMany(relationship.name) !== 'undefined', {
390
- id: 'ds.serializer.embedded-relationship-undefined'
391
- });
392
- json[serializedKey] = this._generateSerializedHasMany(snapshot, relationship);
393
- },
394
- /*
395
- Returns an array of embedded records serialized to JSON
396
- */
397
- _generateSerializedHasMany(snapshot, relationship) {
398
- const hasMany = snapshot.hasMany(relationship.name) || [];
399
- const ret = new Array(hasMany.length);
400
- for (let i = 0; i < hasMany.length; i++) {
401
- const embeddedSnapshot = hasMany[i];
402
- const embeddedJson = embeddedSnapshot.serialize({
403
- includeId: true
404
- });
405
- this.removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, embeddedJson);
406
- ret[i] = embeddedJson;
407
- }
408
- return ret;
409
- },
410
- /**
411
- When serializing an embedded record, modify the property (in the `JSON` payload)
412
- that refers to the parent record (foreign key for the relationship).
413
- Serializing a `belongsTo` relationship removes the property that refers to the
414
- parent record
415
- Serializing a `hasMany` relationship does not remove the property that refers to
416
- the parent record.
417
- @public
418
- @param {Snapshot} snapshot
419
- @param {Snapshot} embeddedSnapshot
420
- @param {Object} relationship
421
- @param {Object} json
422
- */
423
- removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, json) {
424
- if (relationship.kind === 'belongsTo') {
425
- const schema = this.store.modelFor(snapshot.modelName);
426
- const parentRecord = schema.inverseFor(relationship.name, this.store);
427
- if (parentRecord) {
428
- const name = parentRecord.name;
429
- const embeddedSerializer = this.store.serializerFor(embeddedSnapshot.modelName);
430
- const parentKey = embeddedSerializer.keyForRelationship(name, parentRecord.kind, 'deserialize');
431
- if (parentKey) {
432
- delete json[parentKey];
433
- }
434
- }
435
- } /*else if (relationship.kind === 'hasMany') {
436
- return;
437
- }*/
438
- },
439
- // checks config for attrs option to embedded (always) - serialize and deserialize
440
- hasEmbeddedAlwaysOption(attr) {
441
- const option = this.attrsOption(attr);
442
- return option && option.embedded === 'always';
443
- },
444
- // checks config for attrs option to serialize ids
445
- hasSerializeRecordsOption(attr) {
446
- const alwaysEmbed = this.hasEmbeddedAlwaysOption(attr);
447
- const option = this.attrsOption(attr);
448
- return alwaysEmbed || option && option.serialize === 'records';
449
- },
450
- // checks config for attrs option to serialize records
451
- hasSerializeIdsOption(attr) {
452
- const option = this.attrsOption(attr);
453
- return option && (option.serialize === 'ids' || option.serialize === 'id');
454
- },
455
- // checks config for attrs option to serialize records as objects containing id and types
456
- hasSerializeIdsAndTypesOption(attr) {
457
- const option = this.attrsOption(attr);
458
- return option && (option.serialize === 'ids-and-types' || option.serialize === 'id-and-type');
459
- },
460
- // checks config for attrs option to serialize records
461
- noSerializeOptionSpecified(attr) {
462
- const option = this.attrsOption(attr);
463
- return !(option && (option.serialize || option.embedded));
464
- },
465
- // checks config for attrs option to deserialize records
466
- // a defined option object for a resource is treated the same as
467
- // `deserialize: 'records'`
468
- hasDeserializeRecordsOption(attr) {
469
- const alwaysEmbed = this.hasEmbeddedAlwaysOption(attr);
470
- const option = this.attrsOption(attr);
471
- return alwaysEmbed || option && option.deserialize === 'records';
472
- },
473
- attrsOption(attr) {
474
- const attrs = this.attrs;
475
- return attrs && (attrs[camelize(attr)] || attrs[attr]);
476
- },
477
- /**
478
- @private
479
- */
480
- _extractEmbeddedRecords(serializer, store, typeClass, partial) {
481
- typeClass.eachRelationship((key, relationship) => {
482
- if (serializer.hasDeserializeRecordsOption(key)) {
483
- if (relationship.kind === 'hasMany') {
484
- this._extractEmbeddedHasMany(store, key, partial, relationship);
485
- }
486
- if (relationship.kind === 'belongsTo') {
487
- this._extractEmbeddedBelongsTo(store, key, partial, relationship);
488
- }
489
- }
490
- });
491
- return partial;
492
- },
493
- /**
494
- @private
495
- */
496
- _extractEmbeddedHasMany(store, key, hash, relationshipMeta) {
497
- const relationshipHash = hash.data?.relationships?.[key]?.data;
498
- if (!relationshipHash) {
499
- return;
500
- }
501
- const hasMany = new Array(relationshipHash.length);
502
- for (let i = 0; i < relationshipHash.length; i++) {
503
- const item = relationshipHash[i];
504
- const {
505
- data,
506
- included
507
- } = this._normalizeEmbeddedRelationship(store, relationshipMeta, item);
508
- hash.included = hash.included || [];
509
- hash.included.push(data);
510
- if (included) {
511
- hash.included = hash.included.concat(included);
512
- }
513
- hasMany[i] = {
514
- id: data.id,
515
- type: data.type
516
- };
517
- if (data.lid) {
518
- hasMany[i].lid = data.lid;
519
- }
520
- }
521
- const relationship = {
522
- data: hasMany
523
- };
524
- hash.data.relationships[key] = relationship;
525
- },
526
- /**
527
- @private
528
- */
529
- _extractEmbeddedBelongsTo(store, key, hash, relationshipMeta) {
530
- const relationshipHash = hash.data?.relationships?.[key]?.data;
531
- if (!relationshipHash) {
532
- return;
533
- }
534
- const {
535
- data,
536
- included
537
- } = this._normalizeEmbeddedRelationship(store, relationshipMeta, relationshipHash);
538
- hash.included = hash.included || [];
539
- hash.included.push(data);
540
- if (included) {
541
- hash.included = hash.included.concat(included);
542
- }
543
- const belongsTo = {
544
- id: data.id,
545
- type: data.type
546
- };
547
- const relationship = {
548
- data: belongsTo
549
- };
550
- if (data.lid) {
551
- // @ts-expect-error
552
- belongsTo.lid = data.lid;
553
- }
554
- hash.data.relationships[key] = relationship;
555
- },
556
- /**
557
- @private
558
- */
559
- _normalizeEmbeddedRelationship(store, relationshipMeta, relationshipHash) {
560
- let modelName = relationshipMeta.type;
561
- if (relationshipMeta.options.polymorphic) {
562
- modelName = relationshipHash.type;
563
- }
564
- const modelClass = store.modelFor(modelName);
565
- const serializer = store.serializerFor(modelName);
566
- return serializer.normalize(modelClass, relationshipHash, null);
567
- },
568
- isEmbeddedRecordsMixin: true
98
+ /**
99
+ Normalize the record and recursively normalize/extract all the embedded records
100
+ while pushing them into the store as they are encountered
101
+ A payload with an attr configured for embedded records needs to be extracted:
102
+ ```js
103
+ {
104
+ "post": {
105
+ "id": "1"
106
+ "title": "Rails is omakase",
107
+ "comments": [{
108
+ "id": "1",
109
+ "body": "Rails is unagi"
110
+ }, {
111
+ "id": "2",
112
+ "body": "Omakase O_o"
113
+ }]
114
+ }
115
+ }
116
+ ```
117
+ @public
118
+ @param {Model} typeClass
119
+ @param {Object} hash to be normalized
120
+ @param {String} prop the hash has been referenced by
121
+ @return {Object} the normalized hash
122
+ **/
123
+ normalize(typeClass, hash, prop) {
124
+ const normalizedHash = this._super(typeClass, hash, prop);
125
+ return this._extractEmbeddedRecords(this, this.store, typeClass, normalizedHash);
126
+ },
127
+ keyForRelationship(key, typeClass, method) {
128
+ if (method === "serialize" && this.hasSerializeRecordsOption(key) || method === "deserialize" && this.hasDeserializeRecordsOption(key)) return this.keyForAttribute(key, method);
129
+ else return this._super(key, typeClass, method) || key;
130
+ },
131
+ /**
132
+ Serialize `belongsTo` relationship when it is configured as an embedded object.
133
+ This example of an author model belongs to a post model:
134
+ ```js
135
+ import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
136
+ Post = Model.extend({
137
+ title: attr('string'),
138
+ body: attr('string'),
139
+ author: belongsTo('author')
140
+ });
141
+ Author = Model.extend({
142
+ name: attr('string'),
143
+ post: belongsTo('post')
144
+ });
145
+ ```
146
+ Use a custom (type) serializer for the post model to configure embedded author
147
+ ```js [app/serializers/post.js]
148
+ import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
149
+ export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
150
+ attrs = {
151
+ author: { embedded: 'always' }
152
+ }
153
+ }
154
+ ```
155
+ A payload with an attribute configured for embedded records can serialize
156
+ the records together under the root attribute's payload:
157
+ ```js
158
+ {
159
+ "post": {
160
+ "id": "1"
161
+ "title": "Rails is omakase",
162
+ "author": {
163
+ "id": "2"
164
+ "name": "dhh"
165
+ }
166
+ }
167
+ }
168
+ ```
169
+ @public
170
+ @param {Snapshot} snapshot
171
+ @param {Object} json
172
+ @param {Object} relationship
173
+ */
174
+ serializeBelongsTo(snapshot, json, relationship) {
175
+ const attr = relationship.name;
176
+ if (this.noSerializeOptionSpecified(attr)) {
177
+ this._super(snapshot, json, relationship);
178
+ return;
179
+ }
180
+ const includeIds = this.hasSerializeIdsOption(attr);
181
+ const includeRecords = this.hasSerializeRecordsOption(attr);
182
+ const embeddedSnapshot = snapshot.belongsTo(attr);
183
+ if (includeIds) {
184
+ const schema = this.store.modelFor(snapshot.modelName);
185
+ let serializedKey = this._getMappedKey(relationship.name, schema);
186
+ if (serializedKey === relationship.name && this.keyForRelationship) serializedKey = this.keyForRelationship(relationship.name, relationship.kind, "serialize");
187
+ if (!embeddedSnapshot) json[serializedKey] = null;
188
+ else {
189
+ json[serializedKey] = embeddedSnapshot.id;
190
+ if (relationship.options.polymorphic) this.serializePolymorphicType(snapshot, json, relationship);
191
+ }
192
+ } else if (includeRecords) this._serializeEmbeddedBelongsTo(snapshot, json, relationship);
193
+ },
194
+ _serializeEmbeddedBelongsTo(snapshot, json, relationship) {
195
+ const embeddedSnapshot = snapshot.belongsTo(relationship.name);
196
+ const schema = this.store.modelFor(snapshot.modelName);
197
+ let serializedKey = this._getMappedKey(relationship.name, schema);
198
+ if (serializedKey === relationship.name && this.keyForRelationship) serializedKey = this.keyForRelationship(relationship.name, relationship.kind, "serialize");
199
+ if (!embeddedSnapshot) json[serializedKey] = null;
200
+ else {
201
+ json[serializedKey] = embeddedSnapshot.serialize({ includeId: true });
202
+ this.removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, json[serializedKey]);
203
+ if (relationship.options.polymorphic) this.serializePolymorphicType(snapshot, json, relationship);
204
+ }
205
+ },
206
+ /**
207
+ Serializes `hasMany` relationships when it is configured as embedded objects.
208
+ This example of a post model has many comments:
209
+ ```js
210
+ import Model, { attr, belongsTo, hasMany } from '@warp-drive/legacy/model';
211
+ Post = Model.extend({
212
+ title: attr('string'),
213
+ body: attr('string'),
214
+ comments: hasMany('comment')
215
+ });
216
+ Comment = Model.extend({
217
+ body: attr('string'),
218
+ post: belongsTo('post')
219
+ });
220
+ ```
221
+ Use a custom (type) serializer for the post model to configure embedded comments
222
+ ```js [app/serializers/post.js]
223
+ import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
224
+ export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
225
+ attrs = {
226
+ comments: { embedded: 'always' }
227
+ }
228
+ }
229
+ ```
230
+ A payload with an attribute configured for embedded records can serialize
231
+ the records together under the root attribute's payload:
232
+ ```js
233
+ {
234
+ "post": {
235
+ "id": "1"
236
+ "title": "Rails is omakase",
237
+ "body": "I want this for my ORM, I want that for my template language..."
238
+ "comments": [{
239
+ "id": "1",
240
+ "body": "Rails is unagi"
241
+ }, {
242
+ "id": "2",
243
+ "body": "Omakase O_o"
244
+ }]
245
+ }
246
+ }
247
+ ```
248
+ The attrs options object can use more specific instruction for extracting and
249
+ serializing. When serializing, an option to embed `ids`, `ids-and-types` or `records` can be set.
250
+ When extracting the only option is `records`.
251
+ So `{ embedded: 'always' }` is shorthand for:
252
+ `{ serialize: 'records', deserialize: 'records' }`
253
+ To embed the `ids` for a related object (using a hasMany relationship):
254
+ ```js [app/serializers/post.js]
255
+ import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
256
+ export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
257
+ attrs = {
258
+ comments: { serialize: 'ids', deserialize: 'records' }
259
+ }
260
+ }
261
+ ```
262
+ ```js
263
+ {
264
+ "post": {
265
+ "id": "1"
266
+ "title": "Rails is omakase",
267
+ "body": "I want this for my ORM, I want that for my template language..."
268
+ "comments": ["1", "2"]
269
+ }
270
+ }
271
+ ```
272
+ To embed the relationship as a collection of objects with `id` and `type` keys, set
273
+ `ids-and-types` for the related object.
274
+ This is particularly useful for polymorphic relationships where records don't share
275
+ the same table and the `id` is not enough information.
276
+ For example having a user that has many pets:
277
+ ```js
278
+ User = Model.extend({
279
+ name: attr('string'),
280
+ pets: hasMany('pet', { polymorphic: true })
281
+ });
282
+ Pet = Model.extend({
283
+ name: attr('string'),
284
+ });
285
+ Cat = Pet.extend({
286
+ // ...
287
+ });
288
+ Parrot = Pet.extend({
289
+ // ...
290
+ });
291
+ ```
292
+ ```js [app/serializers/user.js]
293
+ import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
294
+ export default class UserSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
295
+ attrs = {
296
+ pets: { serialize: 'ids-and-types', deserialize: 'records' }
297
+ }
298
+ }
299
+ ```
300
+ ```js
301
+ {
302
+ "user": {
303
+ "id": "1"
304
+ "name": "Bertin Osborne",
305
+ "pets": [
306
+ { "id": "1", "type": "Cat" },
307
+ { "id": "1", "type": "Parrot"}
308
+ ]
309
+ }
310
+ }
311
+ ```
312
+ @public
313
+ @param {Snapshot} snapshot
314
+ @param {Object} json
315
+ @param {Object} relationship
316
+ */
317
+ serializeHasMany(snapshot, json, relationship) {
318
+ const attr = relationship.name;
319
+ if (this.noSerializeOptionSpecified(attr)) {
320
+ this._super(snapshot, json, relationship);
321
+ return;
322
+ }
323
+ if (this.hasSerializeIdsOption(attr)) {
324
+ const schema = this.store.modelFor(snapshot.modelName);
325
+ let serializedKey = this._getMappedKey(relationship.name, schema);
326
+ if (serializedKey === relationship.name && this.keyForRelationship) serializedKey = this.keyForRelationship(relationship.name, relationship.kind, "serialize");
327
+ json[serializedKey] = snapshot.hasMany(attr, { ids: true });
328
+ } else if (this.hasSerializeRecordsOption(attr)) this._serializeEmbeddedHasMany(snapshot, json, relationship);
329
+ else if (this.hasSerializeIdsAndTypesOption(attr)) this._serializeHasManyAsIdsAndTypes(snapshot, json, relationship);
330
+ },
331
+ _serializeHasManyAsIdsAndTypes(snapshot, json, relationship) {
332
+ const serializedKey = this.keyForAttribute(relationship.name, "serialize");
333
+ json[serializedKey] = (snapshot.hasMany(relationship.name) || []).map(function(recordSnapshot) {
334
+ return {
335
+ id: recordSnapshot.id,
336
+ type: recordSnapshot.modelName
337
+ };
338
+ });
339
+ },
340
+ _serializeEmbeddedHasMany(snapshot, json, relationship) {
341
+ const schema = this.store.modelFor(snapshot.modelName);
342
+ let serializedKey = this._getMappedKey(relationship.name, schema);
343
+ if (serializedKey === relationship.name && this.keyForRelationship) serializedKey = this.keyForRelationship(relationship.name, relationship.kind, "serialize");
344
+ warn(`The embedded relationship '${serializedKey}' is undefined for '${snapshot.modelName}' with id '${snapshot.id}'. Please include it in your original payload.`, typeof snapshot.hasMany(relationship.name) !== "undefined", { id: "ds.serializer.embedded-relationship-undefined" });
345
+ json[serializedKey] = this._generateSerializedHasMany(snapshot, relationship);
346
+ },
347
+ _generateSerializedHasMany(snapshot, relationship) {
348
+ const hasMany = snapshot.hasMany(relationship.name) || [];
349
+ const ret = new Array(hasMany.length);
350
+ for (let i = 0; i < hasMany.length; i++) {
351
+ const embeddedSnapshot = hasMany[i];
352
+ const embeddedJson = embeddedSnapshot.serialize({ includeId: true });
353
+ this.removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, embeddedJson);
354
+ ret[i] = embeddedJson;
355
+ }
356
+ return ret;
357
+ },
358
+ /**
359
+ When serializing an embedded record, modify the property (in the `JSON` payload)
360
+ that refers to the parent record (foreign key for the relationship).
361
+ Serializing a `belongsTo` relationship removes the property that refers to the
362
+ parent record
363
+ Serializing a `hasMany` relationship does not remove the property that refers to
364
+ the parent record.
365
+ @public
366
+ @param {Snapshot} snapshot
367
+ @param {Snapshot} embeddedSnapshot
368
+ @param {Object} relationship
369
+ @param {Object} json
370
+ */
371
+ removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, json) {
372
+ if (relationship.kind === "belongsTo") {
373
+ const parentRecord = inverseForRelationship(this.store, snapshot.modelName, relationship.name);
374
+ if (parentRecord) {
375
+ const name = parentRecord.name;
376
+ const parentKey = this.store.serializerFor(embeddedSnapshot.modelName).keyForRelationship(name, parentRecord.kind, "deserialize");
377
+ if (parentKey) delete json[parentKey];
378
+ }
379
+ }
380
+ },
381
+ hasEmbeddedAlwaysOption(attr) {
382
+ const option = this.attrsOption(attr);
383
+ return option && option.embedded === "always";
384
+ },
385
+ hasSerializeRecordsOption(attr) {
386
+ const alwaysEmbed = this.hasEmbeddedAlwaysOption(attr);
387
+ const option = this.attrsOption(attr);
388
+ return alwaysEmbed || option && option.serialize === "records";
389
+ },
390
+ hasSerializeIdsOption(attr) {
391
+ const option = this.attrsOption(attr);
392
+ return option && (option.serialize === "ids" || option.serialize === "id");
393
+ },
394
+ hasSerializeIdsAndTypesOption(attr) {
395
+ const option = this.attrsOption(attr);
396
+ return option && (option.serialize === "ids-and-types" || option.serialize === "id-and-type");
397
+ },
398
+ noSerializeOptionSpecified(attr) {
399
+ const option = this.attrsOption(attr);
400
+ return !(option && (option.serialize || option.embedded));
401
+ },
402
+ hasDeserializeRecordsOption(attr) {
403
+ const alwaysEmbed = this.hasEmbeddedAlwaysOption(attr);
404
+ const option = this.attrsOption(attr);
405
+ return alwaysEmbed || option && option.deserialize === "records";
406
+ },
407
+ attrsOption(attr) {
408
+ const attrs = this.attrs;
409
+ return attrs && (attrs[camelize(attr)] || attrs[attr]);
410
+ },
411
+ /**
412
+ @private
413
+ */
414
+ _extractEmbeddedRecords(serializer, store, typeClass, partial) {
415
+ typeClass.eachRelationship((key, relationship) => {
416
+ if (serializer.hasDeserializeRecordsOption(key)) {
417
+ if (relationship.kind === "hasMany") this._extractEmbeddedHasMany(store, key, partial, relationship);
418
+ if (relationship.kind === "belongsTo") this._extractEmbeddedBelongsTo(store, key, partial, relationship);
419
+ }
420
+ });
421
+ return partial;
422
+ },
423
+ /**
424
+ @private
425
+ */
426
+ _extractEmbeddedHasMany(store, key, hash, relationshipMeta) {
427
+ const relationshipHash = hash.data?.relationships?.[key]?.data;
428
+ if (!relationshipHash) return;
429
+ const hasMany = new Array(relationshipHash.length);
430
+ for (let i = 0; i < relationshipHash.length; i++) {
431
+ const item = relationshipHash[i];
432
+ const { data, included } = this._normalizeEmbeddedRelationship(store, relationshipMeta, item);
433
+ hash.included = hash.included || [];
434
+ hash.included.push(data);
435
+ if (included) hash.included = hash.included.concat(included);
436
+ hasMany[i] = {
437
+ id: data.id,
438
+ type: data.type
439
+ };
440
+ if (data.lid) hasMany[i].lid = data.lid;
441
+ }
442
+ const relationship = { data: hasMany };
443
+ hash.data.relationships[key] = relationship;
444
+ },
445
+ /**
446
+ @private
447
+ */
448
+ _extractEmbeddedBelongsTo(store, key, hash, relationshipMeta) {
449
+ const relationshipHash = hash.data?.relationships?.[key]?.data;
450
+ if (!relationshipHash) return;
451
+ const { data, included } = this._normalizeEmbeddedRelationship(store, relationshipMeta, relationshipHash);
452
+ hash.included = hash.included || [];
453
+ hash.included.push(data);
454
+ if (included) hash.included = hash.included.concat(included);
455
+ const belongsTo = {
456
+ id: data.id,
457
+ type: data.type
458
+ };
459
+ const relationship = { data: belongsTo };
460
+ if (data.lid) belongsTo.lid = data.lid;
461
+ hash.data.relationships[key] = relationship;
462
+ },
463
+ /**
464
+ @private
465
+ */
466
+ _normalizeEmbeddedRelationship(store, relationshipMeta, relationshipHash) {
467
+ let modelName = relationshipMeta.type;
468
+ if (relationshipMeta.options.polymorphic) modelName = relationshipHash.type;
469
+ const modelClass = store.modelFor(modelName);
470
+ return store.serializerFor(modelName).normalize(modelClass, relationshipHash, null);
471
+ },
472
+ isEmbeddedRecordsMixin: true
569
473
  });
570
474
 
571
- /* eslint-disable @typescript-eslint/no-unsafe-argument */
572
- /* eslint-disable @typescript-eslint/no-unsafe-member-access */
573
- /* eslint-disable @typescript-eslint/no-unsafe-assignment */
574
- /* eslint-disable @typescript-eslint/no-unsafe-call */
575
- /* eslint-disable @typescript-eslint/no-unsafe-return */
475
+ //#endregion
476
+ //#region src/serializer/rest.ts
576
477
  function makeArray(value) {
577
- return Array.isArray(value) ? value : [value];
478
+ return Array.isArray(value) ? value : [value];
578
479
  }
579
-
580
480
  /**
581
- * :::danger
582
- ⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
583
- If starting a new app or thinking of implementing a new adapter, consider writing a
584
- {@link Handler} instead to be used with the {@link RequestManager}
585
- :::
481
+ * :::danger
482
+ ⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
483
+ If starting a new app or thinking of implementing a new adapter, consider writing a
484
+ {@link Handler} instead to be used with the {@link RequestManager}
485
+ :::
586
486
 
587
- Normally, applications will use the `RESTSerializer` by implementing
588
- the `normalize` method.
487
+ Normally, applications will use the `RESTSerializer` by implementing
488
+ the `normalize` method.
589
489
 
590
- This allows you to do whatever kind of munging you need and is
591
- especially useful if your server is inconsistent and you need to
592
- do munging differently for many different kinds of responses.
490
+ This allows you to do whatever kind of munging you need and is
491
+ especially useful if your server is inconsistent and you need to
492
+ do munging differently for many different kinds of responses.
593
493
 
594
- See the `normalize` documentation for more information.
494
+ See the `normalize` documentation for more information.
595
495
 
596
- ## Across the Board Normalization
496
+ ## Across the Board Normalization
597
497
 
598
- There are also a number of hooks that you might find useful to define
599
- across-the-board rules for your payload. These rules will be useful
600
- if your server is consistent, or if you're building an adapter for
601
- an infrastructure service, like Firebase, and want to encode service
602
- conventions.
498
+ There are also a number of hooks that you might find useful to define
499
+ across-the-board rules for your payload. These rules will be useful
500
+ if your server is consistent, or if you're building an adapter for
501
+ an infrastructure service, like Firebase, and want to encode service
502
+ conventions.
603
503
 
604
- For example, if all of your keys are underscored and all-caps, but
605
- otherwise consistent with the names you use in your models, you
606
- can implement across-the-board rules for how to convert an attribute
607
- name in your model to a key in your JSON.
504
+ For example, if all of your keys are underscored and all-caps, but
505
+ otherwise consistent with the names you use in your models, you
506
+ can implement across-the-board rules for how to convert an attribute
507
+ name in your model to a key in your JSON.
608
508
 
609
- ```js [app/serializers/application.js]
610
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
611
- import { underscore } from '<app-name>/utils/string-utils';
509
+ ```js [app/serializers/application.js]
510
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
511
+ import { underscore } from '<app-name>/utils/string-utils';
612
512
 
613
- export default class ApplicationSerializer extends RESTSerializer {
614
- keyForAttribute(attr, method) {
615
- return underscore(attr).toUpperCase();
616
- }
617
- }
618
- ```
513
+ export default class ApplicationSerializer extends RESTSerializer {
514
+ keyForAttribute(attr, method) {
515
+ return underscore(attr).toUpperCase();
516
+ }
517
+ }
518
+ ```
619
519
 
620
- You can also implement `keyForRelationship`, which takes the name
621
- of the relationship as the first parameter, the kind of
622
- relationship (`hasMany` or `belongsTo`) as the second parameter, and
623
- the method (`serialize` or `deserialize`) as the third parameter.
520
+ You can also implement `keyForRelationship`, which takes the name
521
+ of the relationship as the first parameter, the kind of
522
+ relationship (`hasMany` or `belongsTo`) as the second parameter, and
523
+ the method (`serialize` or `deserialize`) as the third parameter.
624
524
 
625
- @class RESTSerializer
626
- @public
525
+ @class RESTSerializer
526
+ @public
627
527
  */
628
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
629
528
  const RESTSerializer = JSONSerializer.extend({
630
- /**
631
- `keyForPolymorphicType` can be used to define a custom key when
632
- serializing and deserializing a polymorphic type. By default, the
633
- returned key is `${key}Type`.
634
- Example
635
- ```js [app/serializers/post.js]
636
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
637
- export default class ApplicationSerializer extends RESTSerializer {
638
- keyForPolymorphicType(key, relationship) {
639
- let relationshipKey = this.keyForRelationship(key);
640
- return 'type-' + relationshipKey;
641
- }
642
- }
643
- ```
644
- @public
645
- */
646
- keyForPolymorphicType(key, type, method) {
647
- // @ts-expect-error
648
- const relationshipKey = this.keyForRelationship(key);
649
- return `${relationshipKey}Type`;
650
- },
651
- /**
652
- Normalizes a part of the JSON payload returned by
653
- the server. You should override this method, munge the hash
654
- and call super if you have generic normalization to do.
655
- It takes the type of the record that is being normalized
656
- (as a Model class), the property where the hash was
657
- originally found, and the hash to normalize.
658
- For example, if you have a payload that looks like this:
659
- ```js
660
- {
661
- "post": {
662
- "id": 1,
663
- "title": "Rails is omakase",
664
- "comments": [ 1, 2 ]
665
- },
666
- "comments": [{
667
- "id": 1,
668
- "body": "FIRST"
669
- }, {
670
- "id": 2,
671
- "body": "Rails is unagi"
672
- }]
673
- }
674
- ```
675
- The `normalize` method will be called three times:
676
- * With `App.Post`, `"posts"` and `{ id: 1, title: "Rails is omakase", ... }`
677
- * With `App.Comment`, `"comments"` and `{ id: 1, body: "FIRST" }`
678
- * With `App.Comment`, `"comments"` and `{ id: 2, body: "Rails is unagi" }`
679
- You can use this method, for example, to normalize underscored keys to camelized
680
- or other general-purpose normalizations. You will only need to implement
681
- `normalize` and manipulate the payload as desired.
682
- For example, if the `IDs` under `"comments"` are provided as `_id` instead of
683
- `id`, you can specify how to normalize just the comments:
684
- ```js [app/serializers/post.js]
685
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
686
- export default class ApplicationSerializer extends RESTSerializer {
687
- normalize(model, hash, prop) {
688
- if (prop === 'comments') {
689
- hash.id = hash._id;
690
- delete hash._id;
691
- }
692
- return super.normalize(...arguments);
693
- }
694
- }
695
- ```
696
- On each call to the `normalize` method, the third parameter (`prop`) is always
697
- one of the keys that were in the original payload or in the result of another
698
- normalization as `normalizeResponse`.
699
- @public
700
- @param {Model} modelClass
701
- @param {Object} resourceHash
702
- @param {String} prop
703
- @return {Object}
704
- */
705
-
706
- /**
707
- Normalizes an array of resource payloads and returns a JSON-API Document
708
- with primary data and, if any, included data as `{ data, included }`.
709
- @private
710
- */
711
- _normalizeArray(store, modelName, arrayHash, prop) {
712
- const documentHash = {
713
- data: [],
714
- included: []
715
- };
716
- const modelClass = store.modelFor(modelName);
717
- const serializer = store.serializerFor(modelName);
718
- makeArray(arrayHash).forEach(hash => {
719
- // @ts-expect-error
720
- const {
721
- data,
722
- included
723
- } = this._normalizePolymorphicRecord(store, hash, prop, modelClass, serializer);
724
- // @ts-expect-error
725
- documentHash.data.push(data);
726
- if (included) {
727
- documentHash.included = documentHash.included.concat(included);
728
- }
729
- });
730
- return documentHash;
731
- },
732
- _normalizePolymorphicRecord(store, hash, prop, primaryModelClass, primarySerializer) {
733
- let serializer = primarySerializer;
734
- let modelClass = primaryModelClass;
735
- const primaryHasTypeAttribute = primaryModelClass.fields.has('type');
736
-
737
- // @ts-expect-error all the errors
738
- if (!primaryHasTypeAttribute && hash.type) {
739
- // Support polymorphic records in async relationships
740
- // @ts-expect-error all the errors
741
- const type = this.modelNameFromPayloadKey(hash.type);
742
- if (store.schema.hasResource({
743
- type
744
- })) {
745
- serializer = store.serializerFor(type);
746
- modelClass = store.modelFor(type);
747
- }
748
- }
749
-
750
- // @ts-expect-error all the errors
751
- return serializer.normalize(modelClass, hash, prop);
752
- },
753
- /**
754
- @private
755
- */
756
- _normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
757
- const documentHash = {
758
- data: null,
759
- included: []
760
- };
761
- // @ts-expect-error
762
- const meta = this.extractMeta(store, primaryModelClass, payload);
763
- if (meta) {
764
- macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
765
- if (!test) {
766
- throw new Error('The `meta` returned from `extractMeta` has to be an object, not "' + typeof meta + '".');
767
- }
768
- })(typeof meta === 'object') : {}; // @ts-expect-error
769
- documentHash.meta = meta;
770
- }
771
- const keys = Object.keys(payload);
772
- for (let i = 0, length = keys.length; i < length; i++) {
773
- const prop = keys[i];
774
- let modelName = prop;
775
- let forcedSecondary = false;
776
-
777
- /*
778
- If you want to provide sideloaded records of the same type that the
779
- primary data you can do that by prefixing the key with `_`.
780
- Example
781
- ```
782
- {
783
- users: [
784
- { id: 1, title: 'Tom', manager: 3 },
785
- { id: 2, title: 'Yehuda', manager: 3 }
786
- ],
787
- _users: [
788
- { id: 3, title: 'Tomster' }
789
- ]
790
- }
791
- ```
792
- This forces `_users` to be added to `included` instead of `data`.
793
- */
794
- if (prop.charAt(0) === '_') {
795
- forcedSecondary = true;
796
- modelName = prop.substr(1);
797
- }
798
- const type = this.modelNameFromPayloadKey(modelName);
799
- if (!store.schema.hasResource({
800
- type
801
- })) {
802
- if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
803
- // @ts-expect-error
804
- warn(this.warnMessageNoModelForKey(modelName, type), false, {
805
- id: 'ds.serializer.model-for-key-missing'
806
- });
807
- }
808
- continue;
809
- }
810
-
811
- // eslint-disable-next-line no-var
812
- var isPrimary = !forcedSecondary && this.isPrimaryType(store, type, primaryModelClass);
813
- const value = payload[prop];
814
- if (value === null) {
815
- continue;
816
- }
817
- macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
818
- if (!test) {
819
- throw new Error('The adapter returned an array for the primary data of a `queryRecord` response. `queryRecord` should return a single record.');
820
- }
821
- })(!(requestType === 'queryRecord' && isPrimary && Array.isArray(value))) : {};
822
-
823
- /*
824
- Support primary data as an object instead of an array.
825
- Example
826
- ```
827
- {
828
- user: { id: 1, title: 'Tom', manager: 3 }
829
- }
830
- ```
831
- */
832
- if (isPrimary && !Array.isArray(value)) {
833
- // @ts-expect-error
834
- const {
835
- data,
836
- included
837
- } = this._normalizePolymorphicRecord(store, value, prop, primaryModelClass, this);
838
- documentHash.data = data;
839
- if (included) {
840
- documentHash.included = documentHash.included.concat(included);
841
- }
842
- continue;
843
- }
844
- // @ts-expect-error
845
- const {
846
- data,
847
- included
848
- } = this._normalizeArray(store, type, value, prop);
849
- if (included) {
850
- documentHash.included = documentHash.included.concat(included);
851
- }
852
- if (isSingle) {
853
- // eslint-disable-next-line @typescript-eslint/no-loop-func
854
- data.forEach(resource => {
855
- /*
856
- Figures out if this is the primary record or not.
857
- It's either:
858
- 1. The record with the same ID as the original request
859
- 2. If it's a newly created record without an ID, the first record
860
- in the array
861
- */
862
- const isUpdatedRecord = isPrimary && coerceId(resource.id) === id;
863
- const isFirstCreatedRecord = isPrimary && !id && !documentHash.data;
864
- if (isFirstCreatedRecord || isUpdatedRecord) {
865
- documentHash.data = resource;
866
- } else {
867
- // @ts-expect-error
868
- documentHash.included.push(resource);
869
- }
870
- });
871
- } else {
872
- if (isPrimary) {
873
- documentHash.data = data;
874
- } else {
875
- if (data) {
876
- documentHash.included = documentHash.included.concat(data);
877
- }
878
- }
879
- }
880
- }
881
- return documentHash;
882
- },
883
- isPrimaryType(store, modelName, primaryModelClass) {
884
- return dasherize(modelName) === primaryModelClass.modelName;
885
- },
886
- /**
887
- This method allows you to push a payload containing top-level
888
- collections of records organized per type.
889
- ```js
890
- {
891
- "posts": [{
892
- "id": "1",
893
- "title": "Rails is omakase",
894
- "author", "1",
895
- "comments": [ "1" ]
896
- }],
897
- "comments": [{
898
- "id": "1",
899
- "body": "FIRST"
900
- }],
901
- "users": [{
902
- "id": "1",
903
- "name": "@d2h"
904
- }]
905
- }
906
- ```
907
- It will first normalize the payload, so you can use this to push
908
- in data streaming in from your server structured the same way
909
- that fetches and saves are structured.
910
- @public
911
- */
912
- pushPayload(store, payload) {
913
- const documentHash = {
914
- data: [],
915
- included: []
916
- };
917
- for (const prop in payload) {
918
- const type = this.modelNameFromPayloadKey(prop);
919
- if (!store.schema.hasResource({
920
- type
921
- })) {
922
- if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
923
- // @ts-expect-error
924
- warn(this.warnMessageNoModelForKey(prop, type), false, {
925
- id: 'ds.serializer.model-for-key-missing'
926
- });
927
- }
928
- continue;
929
- }
930
- const ModelSchema = store.modelFor(type);
931
- const typeSerializer = store.serializerFor(ModelSchema.modelName);
932
- makeArray(payload[prop]).forEach(hash => {
933
- const {
934
- data,
935
- included
936
- } = typeSerializer.normalize(ModelSchema, hash, prop);
937
- // @ts-expect-error
938
- documentHash.data.push(data);
939
- if (included) {
940
- documentHash.included = documentHash.included.concat(included);
941
- }
942
- });
943
- }
944
- store.push(documentHash);
945
- },
946
- /**
947
- This method is used to convert each JSON root key in the payload
948
- into a modelName that it can use to look up the appropriate model for
949
- that part of the payload.
950
- For example, your server may send a model name that does not correspond with
951
- the name of the model in your app. Let's take a look at an example model,
952
- and an example payload:
953
- ```js [app/models/post.js]
954
- import Model from '@warp-drive/legacy/model';
955
- export default class Post extends Model {}
956
- ```
957
- ```javascript
958
- {
959
- "blog/post": {
960
- "id": "1
961
- }
962
- }
963
- ```
964
- Ember Data is going to normalize the payload's root key for the modelName. As a result,
965
- it will try to look up the "blog/post" model. Since we don't have a model called "blog/post"
966
- (or a file called app/models/blog/post.js in ember-cli), Ember Data will throw an error
967
- because it cannot find the "blog/post" model.
968
- Since we want to remove this namespace, we can define a serializer for the application that will
969
- remove "blog/" from the payload key whenver it's encountered by Ember Data:
970
- ```js [app/serializers/application.js]
971
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
972
- export default class ApplicationSerializer extends RESTSerializer {
973
- modelNameFromPayloadKey(payloadKey) {
974
- if (payloadKey === 'blog/post') {
975
- return super.modelNameFromPayloadKey(payloadKey.replace('blog/', ''));
976
- } else {
977
- return super.modelNameFromPayloadKey(payloadKey);
978
- }
979
- }
980
- }
981
- ```
982
- After refreshing, Ember Data will appropriately look up the "post" model.
983
- By default the modelName for a model is its
984
- name in dasherized form. This means that a payload key like "blogPost" would be
985
- normalized to "blog-post" when Ember Data looks up the model. Usually, Ember Data
986
- can use the correct inflection to do this for you. Most of the time, you won't
987
- need to override `modelNameFromPayloadKey` for this purpose.
988
- @public
989
- @return the model's modelName
990
- */
991
- modelNameFromPayloadKey(key) {
992
- return dasherize(singularize(key));
993
- },
994
- // SERIALIZE
995
-
996
- /**
997
- Called when a record is saved in order to convert the
998
- record into JSON.
999
- By default, it creates a JSON object with a key for
1000
- each attribute and belongsTo relationship.
1001
- For example, consider this model:
1002
- ```js [app/models/comment.js]
1003
- import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
1004
- export default class Comment extends Model {
1005
- @attr title
1006
- @attr body
1007
- @belongsTo('user') author
1008
- }
1009
- ```
1010
- The default serialization would create a JSON object like:
1011
- ```js
1012
- {
1013
- "title": "Rails is unagi",
1014
- "body": "Rails? Omakase? O_O",
1015
- "author": 12
1016
- }
1017
- ```
1018
- By default, attributes are passed through as-is, unless
1019
- you specified an attribute type (`attr('date')`). If
1020
- you specify a transform, the JavaScript value will be
1021
- serialized when inserted into the JSON hash.
1022
- By default, belongs-to relationships are converted into
1023
- IDs when inserted into the JSON hash.
1024
- ## IDs
1025
- `serialize` takes an options hash with a single option:
1026
- `includeId`. If this option is `true`, `serialize` will,
1027
- by default include the ID in the JSON object it builds.
1028
- The adapter passes in `includeId: true` when serializing
1029
- a record for `createRecord`, but not for `updateRecord`.
1030
- ## Customization
1031
- Your server may expect a different JSON format than the
1032
- built-in serialization format.
1033
- In that case, you can implement `serialize` yourself and
1034
- return a JSON hash of your choosing.
1035
- ```js [app/serializers/post.js]
1036
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
1037
- export default class ApplicationSerializer extends RESTSerializer {
1038
- serialize(snapshot, options) {
1039
- let json = {
1040
- POST_TTL: snapshot.attr('title'),
1041
- POST_BDY: snapshot.attr('body'),
1042
- POST_CMS: snapshot.hasMany('comments', { ids: true })
1043
- };
1044
- if (options.includeId) {
1045
- json.POST_ID_ = snapshot.id;
1046
- }
1047
- return json;
1048
- }
1049
- }
1050
- ```
1051
- ## Customizing an App-Wide Serializer
1052
- If you want to define a serializer for your entire
1053
- application, you'll probably want to use `eachAttribute`
1054
- and `eachRelationship` on the record.
1055
- ```js [app/serializers/application.js]
1056
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
1057
- import { pluralize } from '<app-name>/utils/string-utils';
1058
- export default class ApplicationSerializer extends RESTSerializer {
1059
- serialize(snapshot, options) {
1060
- let json = {};
1061
- snapshot.eachAttribute(function(name) {
1062
- json[serverAttributeName(name)] = snapshot.attr(name);
1063
- });
1064
- snapshot.eachRelationship(function(name, relationship) {
1065
- if (relationship.kind === 'hasMany') {
1066
- json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
1067
- }
1068
- });
1069
- if (options.includeId) {
1070
- json.ID_ = snapshot.id;
1071
- }
1072
- return json;
1073
- }
1074
- }
1075
- function serverAttributeName(attribute) {
1076
- return attribute.underscore().toUpperCase();
1077
- }
1078
- function serverHasManyName(name) {
1079
- return serverAttributeName(singularize(name)) + "_IDS";
1080
- }
1081
- ```
1082
- This serializer will generate JSON that looks like this:
1083
- ```js
1084
- {
1085
- "TITLE": "Rails is omakase",
1086
- "BODY": "Yep. Omakase.",
1087
- "COMMENT_IDS": [ 1, 2, 3 ]
1088
- }
1089
- ```
1090
- ## Tweaking the Default JSON
1091
- If you just want to do some small tweaks on the default JSON,
1092
- you can call super first and make the tweaks on the returned
1093
- JSON.
1094
- ```js [app/serializers/post.js]
1095
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
1096
- export default class ApplicationSerializer extends RESTSerializer {
1097
- serialize(snapshot, options) {
1098
- let json = super.serialize(snapshot, options);
1099
- json.subject = json.title;
1100
- delete json.title;
1101
- return json;
1102
- }
1103
- }
1104
- ```
1105
- @public
1106
- */
1107
- serialize(snapshot, options) {
1108
- // @ts-expect-error
1109
- return this._super(...arguments);
1110
- },
1111
- /**
1112
- You can use this method to customize the root keys serialized into the JSON.
1113
- The hash property should be modified by reference (possibly using something like _.extend)
1114
- By default the REST Serializer sends the modelName of a model, which is a camelized
1115
- version of the name.
1116
- For example, your server may expect underscored root objects.
1117
- ```js [app/serializers/application.js]
1118
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
1119
- import { underscore } from '<app-name>/utils/string-utils';
1120
- export default class ApplicationSerializer extends RESTSerializer {
1121
- serializeIntoHash(data, type, record, options) {
1122
- let root = underscore(type.modelName);
1123
- data[root] = this.serialize(record, options);
1124
- }
1125
- }
1126
- ```
1127
- @public
1128
- */
1129
- serializeIntoHash(hash, typeClass, snapshot, options) {
1130
- const normalizedRootKey = this.payloadKeyFromModelName(typeClass.modelName);
1131
- hash[normalizedRootKey] = this.serialize(snapshot, options);
1132
- },
1133
- /**
1134
- You can use `payloadKeyFromModelName` to override the root key for an outgoing
1135
- request. By default, the RESTSerializer returns a camelized version of the
1136
- model's name.
1137
- For a model called TacoParty, its `modelName` would be the string `taco-party`. The RESTSerializer
1138
- will send it to the server with `tacoParty` as the root key in the JSON payload:
1139
- ```js
1140
- {
1141
- "tacoParty": {
1142
- "id": "1",
1143
- "location": "Matthew Beale's House"
1144
- }
1145
- }
1146
- ```
1147
- For example, your server may expect dasherized root objects:
1148
- ```js [app/serializers/application.js]
1149
- import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
1150
- import { dasherize } from '<app-name>/utils/string-utils';
1151
- export default class ApplicationSerializer extends RESTSerializer {
1152
- payloadKeyFromModelName(modelName) {
1153
- return dasherize(modelName);
1154
- }
1155
- }
1156
- ```
1157
- Given a `TacoParty` model, calling `save` on it would produce an outgoing
1158
- request like:
1159
- ```js
1160
- {
1161
- "taco-party": {
1162
- "id": "1",
1163
- "location": "Matthew Beale's House"
1164
- }
1165
- }
1166
- ```
1167
- @public
1168
- */
1169
- payloadKeyFromModelName(modelName) {
1170
- return camelize(modelName);
1171
- },
1172
- /**
1173
- You can use this method to customize how polymorphic objects are serialized.
1174
- By default the REST Serializer creates the key by appending `Type` to
1175
- the attribute and value from the model's camelcased model name.
1176
- @public
1177
- */
1178
- serializePolymorphicType(snapshot, json, relationship) {
1179
- const name = relationship.name;
1180
- const typeKey = this.keyForPolymorphicType(name, relationship.type, 'serialize');
1181
- const belongsTo = snapshot.belongsTo(name);
1182
- if (!belongsTo) {
1183
- json[typeKey] = null;
1184
- } else {
1185
- // @ts-expect-error
1186
- json[typeKey] = camelize(belongsTo.modelName);
1187
- }
1188
- },
1189
- /**
1190
- You can use this method to customize how a polymorphic relationship should
1191
- be extracted.
1192
- @public
1193
- @param {Object} relationshipType
1194
- @param {Object} relationshipHash
1195
- @param {Object} relationshipOptions
1196
- @return {Object}
1197
- */
1198
- extractPolymorphicRelationship(relationshipType, relationshipHash, relationshipOptions) {
1199
- // @ts-expect-error
1200
- const {
1201
- key,
1202
- resourceHash,
1203
- relationshipMeta
1204
- } = relationshipOptions;
1205
-
1206
- // A polymorphic belongsTo relationship can be present in the payload
1207
- // either in the form where the `id` and the `type` are given:
1208
- //
1209
- // {
1210
- // message: { id: 1, type: 'post' }
1211
- // }
1212
- //
1213
- // or by the `id` and a `<relationship>Type` attribute:
1214
- //
1215
- // {
1216
- // message: 1,
1217
- // messageType: 'post'
1218
- // }
1219
- //
1220
- // The next code checks if the latter case is present and returns the
1221
- // corresponding JSON-API representation. The former case is handled within
1222
- // the base class JSONSerializer.
1223
- const isPolymorphic = relationshipMeta.options.polymorphic;
1224
- const typeProperty = this.keyForPolymorphicType(key, relationshipType, 'deserialize');
1225
- if (isPolymorphic && resourceHash[typeProperty] !== undefined && typeof relationshipHash !== 'object') {
1226
- const type = this.modelNameFromPayloadKey(resourceHash[typeProperty]);
1227
- return {
1228
- id: coerceId(relationshipHash),
1229
- type: type
1230
- };
1231
- }
1232
- // @ts-expect-error
1233
- return this._super(...arguments);
1234
- }
529
+ /**
530
+ `keyForPolymorphicType` can be used to define a custom key when
531
+ serializing and deserializing a polymorphic type. By default, the
532
+ returned key is `${key}Type`.
533
+ Example
534
+ ```js [app/serializers/post.js]
535
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
536
+ export default class ApplicationSerializer extends RESTSerializer {
537
+ keyForPolymorphicType(key, relationship) {
538
+ let relationshipKey = this.keyForRelationship(key);
539
+ return 'type-' + relationshipKey;
540
+ }
541
+ }
542
+ ```
543
+ @public
544
+ */
545
+ keyForPolymorphicType(key, type, method) {
546
+ return `${this.keyForRelationship(key)}Type`;
547
+ },
548
+ /**
549
+ Normalizes a part of the JSON payload returned by
550
+ the server. You should override this method, munge the hash
551
+ and call super if you have generic normalization to do.
552
+ It takes the type of the record that is being normalized
553
+ (as a Model class), the property where the hash was
554
+ originally found, and the hash to normalize.
555
+ For example, if you have a payload that looks like this:
556
+ ```js
557
+ {
558
+ "post": {
559
+ "id": 1,
560
+ "title": "Rails is omakase",
561
+ "comments": [ 1, 2 ]
562
+ },
563
+ "comments": [{
564
+ "id": 1,
565
+ "body": "FIRST"
566
+ }, {
567
+ "id": 2,
568
+ "body": "Rails is unagi"
569
+ }]
570
+ }
571
+ ```
572
+ The `normalize` method will be called three times:
573
+ * With `App.Post`, `"posts"` and `{ id: 1, title: "Rails is omakase", ... }`
574
+ * With `App.Comment`, `"comments"` and `{ id: 1, body: "FIRST" }`
575
+ * With `App.Comment`, `"comments"` and `{ id: 2, body: "Rails is unagi" }`
576
+ You can use this method, for example, to normalize underscored keys to camelized
577
+ or other general-purpose normalizations. You will only need to implement
578
+ `normalize` and manipulate the payload as desired.
579
+ For example, if the `IDs` under `"comments"` are provided as `_id` instead of
580
+ `id`, you can specify how to normalize just the comments:
581
+ ```js [app/serializers/post.js]
582
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
583
+ export default class ApplicationSerializer extends RESTSerializer {
584
+ normalize(model, hash, prop) {
585
+ if (prop === 'comments') {
586
+ hash.id = hash._id;
587
+ delete hash._id;
588
+ }
589
+ return super.normalize(...arguments);
590
+ }
591
+ }
592
+ ```
593
+ On each call to the `normalize` method, the third parameter (`prop`) is always
594
+ one of the keys that were in the original payload or in the result of another
595
+ normalization as `normalizeResponse`.
596
+ @public
597
+ @param {Model} modelClass
598
+ @param {Object} resourceHash
599
+ @param {String} prop
600
+ @return {Object}
601
+ */
602
+ /**
603
+ Normalizes an array of resource payloads and returns a JSON-API Document
604
+ with primary data and, if any, included data as `{ data, included }`.
605
+ @private
606
+ */
607
+ _normalizeArray(store, modelName, arrayHash, prop) {
608
+ const documentHash = {
609
+ data: [],
610
+ included: []
611
+ };
612
+ const modelClass = store.modelFor(modelName);
613
+ const serializer = store.serializerFor(modelName);
614
+ makeArray(arrayHash).forEach((hash) => {
615
+ const { data, included } = this._normalizePolymorphicRecord(store, hash, prop, modelClass, serializer);
616
+ documentHash.data.push(data);
617
+ if (included) documentHash.included = documentHash.included.concat(included);
618
+ });
619
+ return documentHash;
620
+ },
621
+ _normalizePolymorphicRecord(store, hash, prop, primaryModelClass, primarySerializer) {
622
+ let serializer = primarySerializer;
623
+ let modelClass = primaryModelClass;
624
+ if (!primaryModelClass.fields.has("type") && hash.type) {
625
+ const type = this.modelNameFromPayloadKey(hash.type);
626
+ if (store.schema.hasResource({ type })) {
627
+ serializer = store.serializerFor(type);
628
+ modelClass = store.modelFor(type);
629
+ }
630
+ }
631
+ return serializer.normalize(modelClass, hash, prop);
632
+ },
633
+ /**
634
+ @private
635
+ */
636
+ _normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
637
+ const documentHash = {
638
+ data: null,
639
+ included: []
640
+ };
641
+ const meta = this.extractMeta(store, primaryModelClass, payload);
642
+ if (meta) {
643
+ macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
644
+ if (!test) throw new Error("The `meta` returned from `extractMeta` has to be an object, not \"" + typeof meta + "\".");
645
+ })(typeof meta === "object");
646
+ documentHash.meta = meta;
647
+ }
648
+ const keys = Object.keys(payload);
649
+ for (let i = 0, length = keys.length; i < length; i++) {
650
+ const prop = keys[i];
651
+ let modelName = prop;
652
+ let forcedSecondary = false;
653
+ if (prop.charAt(0) === "_") {
654
+ forcedSecondary = true;
655
+ modelName = prop.substr(1);
656
+ }
657
+ const type = this.modelNameFromPayloadKey(modelName);
658
+ if (!store.schema.hasResource({ type })) {
659
+ if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) warn(this.warnMessageNoModelForKey(modelName, type), false, { id: "ds.serializer.model-for-key-missing" });
660
+ continue;
661
+ }
662
+ var isPrimary = !forcedSecondary && this.isPrimaryType(store, type, primaryModelClass);
663
+ const value = payload[prop];
664
+ if (value === null) continue;
665
+ macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
666
+ if (!test) throw new Error("The adapter returned an array for the primary data of a `queryRecord` response. `queryRecord` should return a single record.");
667
+ })(!(requestType === "queryRecord" && isPrimary && Array.isArray(value)));
668
+ if (isPrimary && !Array.isArray(value)) {
669
+ const { data, included } = this._normalizePolymorphicRecord(store, value, prop, primaryModelClass, this);
670
+ documentHash.data = data;
671
+ if (included) documentHash.included = documentHash.included.concat(included);
672
+ continue;
673
+ }
674
+ const { data, included } = this._normalizeArray(store, type, value, prop);
675
+ if (included) documentHash.included = documentHash.included.concat(included);
676
+ if (isSingle) data.forEach((resource) => {
677
+ const isUpdatedRecord = isPrimary && coerceId(resource.id) === id;
678
+ if (isPrimary && !id && !documentHash.data || isUpdatedRecord) documentHash.data = resource;
679
+ else documentHash.included.push(resource);
680
+ });
681
+ else if (isPrimary) documentHash.data = data;
682
+ else if (data) documentHash.included = documentHash.included.concat(data);
683
+ }
684
+ return documentHash;
685
+ },
686
+ isPrimaryType(store, modelName, primaryModelClass) {
687
+ return dasherize(modelName) === primaryModelClass.modelName;
688
+ },
689
+ /**
690
+ This method allows you to push a payload containing top-level
691
+ collections of records organized per type.
692
+ ```js
693
+ {
694
+ "posts": [{
695
+ "id": "1",
696
+ "title": "Rails is omakase",
697
+ "author", "1",
698
+ "comments": [ "1" ]
699
+ }],
700
+ "comments": [{
701
+ "id": "1",
702
+ "body": "FIRST"
703
+ }],
704
+ "users": [{
705
+ "id": "1",
706
+ "name": "@d2h"
707
+ }]
708
+ }
709
+ ```
710
+ It will first normalize the payload, so you can use this to push
711
+ in data streaming in from your server structured the same way
712
+ that fetches and saves are structured.
713
+ @public
714
+ */
715
+ pushPayload(store, payload) {
716
+ const documentHash = {
717
+ data: [],
718
+ included: []
719
+ };
720
+ for (const prop in payload) {
721
+ const type = this.modelNameFromPayloadKey(prop);
722
+ if (!store.schema.hasResource({ type })) {
723
+ if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) warn(this.warnMessageNoModelForKey(prop, type), false, { id: "ds.serializer.model-for-key-missing" });
724
+ continue;
725
+ }
726
+ const ModelSchema = store.modelFor(type);
727
+ const typeSerializer = store.serializerFor(ModelSchema.modelName);
728
+ makeArray(payload[prop]).forEach((hash) => {
729
+ const { data, included } = typeSerializer.normalize(ModelSchema, hash, prop);
730
+ documentHash.data.push(data);
731
+ if (included) documentHash.included = documentHash.included.concat(included);
732
+ });
733
+ }
734
+ store.push(documentHash);
735
+ },
736
+ /**
737
+ This method is used to convert each JSON root key in the payload
738
+ into a modelName that it can use to look up the appropriate model for
739
+ that part of the payload.
740
+ For example, your server may send a model name that does not correspond with
741
+ the name of the model in your app. Let's take a look at an example model,
742
+ and an example payload:
743
+ ```js [app/models/post.js]
744
+ import Model from '@warp-drive/legacy/model';
745
+ export default class Post extends Model {}
746
+ ```
747
+ ```javascript
748
+ {
749
+ "blog/post": {
750
+ "id": "1
751
+ }
752
+ }
753
+ ```
754
+ Ember Data is going to normalize the payload's root key for the modelName. As a result,
755
+ it will try to look up the "blog/post" model. Since we don't have a model called "blog/post"
756
+ (or a file called app/models/blog/post.js in ember-cli), Ember Data will throw an error
757
+ because it cannot find the "blog/post" model.
758
+ Since we want to remove this namespace, we can define a serializer for the application that will
759
+ remove "blog/" from the payload key whenver it's encountered by Ember Data:
760
+ ```js [app/serializers/application.js]
761
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
762
+ export default class ApplicationSerializer extends RESTSerializer {
763
+ modelNameFromPayloadKey(payloadKey) {
764
+ if (payloadKey === 'blog/post') {
765
+ return super.modelNameFromPayloadKey(payloadKey.replace('blog/', ''));
766
+ } else {
767
+ return super.modelNameFromPayloadKey(payloadKey);
768
+ }
769
+ }
770
+ }
771
+ ```
772
+ After refreshing, Ember Data will appropriately look up the "post" model.
773
+ By default the modelName for a model is its
774
+ name in dasherized form. This means that a payload key like "blogPost" would be
775
+ normalized to "blog-post" when Ember Data looks up the model. Usually, Ember Data
776
+ can use the correct inflection to do this for you. Most of the time, you won't
777
+ need to override `modelNameFromPayloadKey` for this purpose.
778
+ @public
779
+ @return the model's modelName
780
+ */
781
+ modelNameFromPayloadKey(key) {
782
+ return dasherize(singularize(key));
783
+ },
784
+ /**
785
+ Called when a record is saved in order to convert the
786
+ record into JSON.
787
+ By default, it creates a JSON object with a key for
788
+ each attribute and belongsTo relationship.
789
+ For example, consider this model:
790
+ ```js [app/models/comment.js]
791
+ import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
792
+ export default class Comment extends Model {
793
+ @attr title
794
+ @attr body
795
+ @belongsTo('user') author
796
+ }
797
+ ```
798
+ The default serialization would create a JSON object like:
799
+ ```js
800
+ {
801
+ "title": "Rails is unagi",
802
+ "body": "Rails? Omakase? O_O",
803
+ "author": 12
804
+ }
805
+ ```
806
+ By default, attributes are passed through as-is, unless
807
+ you specified an attribute type (`attr('date')`). If
808
+ you specify a transform, the JavaScript value will be
809
+ serialized when inserted into the JSON hash.
810
+ By default, belongs-to relationships are converted into
811
+ IDs when inserted into the JSON hash.
812
+ ## IDs
813
+ `serialize` takes an options hash with a single option:
814
+ `includeId`. If this option is `true`, `serialize` will,
815
+ by default include the ID in the JSON object it builds.
816
+ The RESTAdapter passes in `includeId: true` when serializing
817
+ a record for `createRecord`, but not for `updateRecord`.
818
+ ## Customization
819
+ Your server may expect a different JSON format than the
820
+ built-in serialization format.
821
+ In that case, you can implement `serialize` yourself and
822
+ return a JSON hash of your choosing.
823
+ ```js [app/serializers/post.js]
824
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
825
+ export default class ApplicationSerializer extends RESTSerializer {
826
+ serialize(snapshot, options) {
827
+ let json = {
828
+ POST_TTL: snapshot.attr('title'),
829
+ POST_BDY: snapshot.attr('body'),
830
+ POST_CMS: snapshot.hasMany('comments', { ids: true })
831
+ };
832
+ if (options.includeId) {
833
+ json.POST_ID_ = snapshot.id;
834
+ }
835
+ return json;
836
+ }
837
+ }
838
+ ```
839
+ ## Customizing an App-Wide Serializer
840
+ If you want to define a serializer for your entire
841
+ application, you'll probably want to use `eachAttribute`
842
+ and `eachRelationship` on the record.
843
+ ```js [app/serializers/application.js]
844
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
845
+ import { pluralize } from '<app-name>/utils/string-utils';
846
+ export default class ApplicationSerializer extends RESTSerializer {
847
+ serialize(snapshot, options) {
848
+ let json = {};
849
+ snapshot.eachAttribute(function(name) {
850
+ json[serverAttributeName(name)] = snapshot.attr(name);
851
+ });
852
+ snapshot.eachRelationship(function(name, relationship) {
853
+ if (relationship.kind === 'hasMany') {
854
+ json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
855
+ }
856
+ });
857
+ if (options.includeId) {
858
+ json.ID_ = snapshot.id;
859
+ }
860
+ return json;
861
+ }
862
+ }
863
+ function serverAttributeName(attribute) {
864
+ return attribute.underscore().toUpperCase();
865
+ }
866
+ function serverHasManyName(name) {
867
+ return serverAttributeName(singularize(name)) + "_IDS";
868
+ }
869
+ ```
870
+ This serializer will generate JSON that looks like this:
871
+ ```js
872
+ {
873
+ "TITLE": "Rails is omakase",
874
+ "BODY": "Yep. Omakase.",
875
+ "COMMENT_IDS": [ 1, 2, 3 ]
876
+ }
877
+ ```
878
+ ## Tweaking the Default JSON
879
+ If you just want to do some small tweaks on the default JSON,
880
+ you can call super first and make the tweaks on the returned
881
+ JSON.
882
+ ```js [app/serializers/post.js]
883
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
884
+ export default class ApplicationSerializer extends RESTSerializer {
885
+ serialize(snapshot, options) {
886
+ let json = super.serialize(snapshot, options);
887
+ json.subject = json.title;
888
+ delete json.title;
889
+ return json;
890
+ }
891
+ }
892
+ ```
893
+ @public
894
+ */
895
+ serialize(snapshot, options) {
896
+ return this._super(...arguments);
897
+ },
898
+ /**
899
+ You can use this method to customize the root keys serialized into the JSON.
900
+ The hash property should be modified by reference (possibly using something like _.extend)
901
+ By default the REST Serializer sends the modelName of a model, which is a camelized
902
+ version of the name.
903
+ For example, your server may expect underscored root objects.
904
+ ```js [app/serializers/application.js]
905
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
906
+ import { underscore } from '<app-name>/utils/string-utils';
907
+ export default class ApplicationSerializer extends RESTSerializer {
908
+ serializeIntoHash(data, type, record, options) {
909
+ let root = underscore(type.modelName);
910
+ data[root] = this.serialize(record, options);
911
+ }
912
+ }
913
+ ```
914
+ @public
915
+ */
916
+ serializeIntoHash(hash, typeClass, snapshot, options) {
917
+ const normalizedRootKey = this.payloadKeyFromModelName(typeClass.modelName);
918
+ hash[normalizedRootKey] = this.serialize(snapshot, options);
919
+ },
920
+ /**
921
+ You can use `payloadKeyFromModelName` to override the root key for an outgoing
922
+ request. By default, the RESTSerializer returns a camelized version of the
923
+ model's name.
924
+ For a model called TacoParty, its `modelName` would be the string `taco-party`. The RESTSerializer
925
+ will send it to the server with `tacoParty` as the root key in the JSON payload:
926
+ ```js
927
+ {
928
+ "tacoParty": {
929
+ "id": "1",
930
+ "location": "Matthew Beale's House"
931
+ }
932
+ }
933
+ ```
934
+ For example, your server may expect dasherized root objects:
935
+ ```js [app/serializers/application.js]
936
+ import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
937
+ import { dasherize } from '<app-name>/utils/string-utils';
938
+ export default class ApplicationSerializer extends RESTSerializer {
939
+ payloadKeyFromModelName(modelName) {
940
+ return dasherize(modelName);
941
+ }
942
+ }
943
+ ```
944
+ Given a `TacoParty` model, calling `save` on it would produce an outgoing
945
+ request like:
946
+ ```js
947
+ {
948
+ "taco-party": {
949
+ "id": "1",
950
+ "location": "Matthew Beale's House"
951
+ }
952
+ }
953
+ ```
954
+ @public
955
+ */
956
+ payloadKeyFromModelName(modelName) {
957
+ return camelize(modelName);
958
+ },
959
+ /**
960
+ You can use this method to customize how polymorphic objects are serialized.
961
+ By default the REST Serializer creates the key by appending `Type` to
962
+ the attribute and value from the model's camelcased model name.
963
+ @public
964
+ */
965
+ serializePolymorphicType(snapshot, json, relationship) {
966
+ const name = relationship.name;
967
+ const typeKey = this.keyForPolymorphicType(name, relationship.type, "serialize");
968
+ const belongsTo = snapshot.belongsTo(name);
969
+ if (!belongsTo) json[typeKey] = null;
970
+ else json[typeKey] = camelize(belongsTo.modelName);
971
+ },
972
+ /**
973
+ You can use this method to customize how a polymorphic relationship should
974
+ be extracted.
975
+ @public
976
+ @param {Object} relationshipType
977
+ @param {Object} relationshipHash
978
+ @param {Object} relationshipOptions
979
+ @return {Object}
980
+ */
981
+ extractPolymorphicRelationship(relationshipType, relationshipHash, relationshipOptions) {
982
+ const { key, resourceHash, relationshipMeta } = relationshipOptions;
983
+ const isPolymorphic = relationshipMeta.options.polymorphic;
984
+ const typeProperty = this.keyForPolymorphicType(key, relationshipType, "deserialize");
985
+ if (isPolymorphic && resourceHash[typeProperty] !== void 0 && typeof relationshipHash !== "object") {
986
+ const type = this.modelNameFromPayloadKey(resourceHash[typeProperty]);
987
+ return {
988
+ id: coerceId(relationshipHash),
989
+ type
990
+ };
991
+ }
992
+ return this._super(...arguments);
993
+ }
1235
994
  });
1236
- if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
1237
- RESTSerializer.reopen({
1238
- warnMessageNoModelForKey(prop, typeKey) {
1239
- return 'Encountered "' + prop + '" in payload, but no model was found for model name "' + typeKey + '" (resolved model name using ' + this.constructor.toString() + '.modelNameFromPayloadKey("' + prop + '"))';
1240
- }
1241
- });
1242
- }
1243
- export { EmbeddedRecordsMixin, RESTSerializer };
995
+ if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) RESTSerializer.reopen({ warnMessageNoModelForKey(prop, typeKey) {
996
+ return "Encountered \"" + prop + "\" in payload, but no model was found for model name \"" + typeKey + "\" (resolved model name using " + this.constructor.toString() + ".modelNameFromPayloadKey(\"" + prop + "\"))";
997
+ } });
998
+
999
+ //#endregion
1000
+ export { EmbeddedRecordsMixin, RESTSerializer };
1001
+ //# sourceMappingURL=rest.js.map