@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,527 +1,540 @@
1
- import { warn } from '@ember/debug';
2
- import { dasherize, pluralize, singularize } from '@warp-drive/utilities/string';
3
- import { J as JSONSerializer } from "../json-ChdEfB0X.js";
4
- import { macroCondition, getGlobalConfig } from '@embroider/macros';
1
+ import { t as JSONSerializer } from "../json-BXNPTlcH.js";
2
+ import { warn } from "@ember/debug";
3
+ import { getGlobalConfig, macroCondition } from "@embroider/macros";
4
+ import { dasherize, pluralize, singularize } from "@warp-drive/utilities/string";
5
5
 
6
- /* eslint-disable @typescript-eslint/no-unsafe-return */
7
- /* eslint-disable @typescript-eslint/no-unsafe-assignment */
8
- /* eslint-disable @typescript-eslint/no-unsafe-argument */
9
- /* eslint-disable @typescript-eslint/no-unsafe-member-access */
10
- /* eslint-disable @typescript-eslint/no-unsafe-call */
11
- const JSONAPISerializer = JSONSerializer.extend({
12
- /**
13
- @private
14
- */
15
- _normalizeDocumentHelper(documentHash) {
16
- if (Array.isArray(documentHash.data)) {
17
- const ret = new Array(documentHash.data.length);
18
- for (let i = 0; i < documentHash.data.length; i++) {
19
- const data = documentHash.data[i];
20
- ret[i] = this._normalizeResourceHelper(data);
21
- }
22
- documentHash.data = ret;
23
- } else if (documentHash.data && typeof documentHash.data === 'object') {
24
- documentHash.data = this._normalizeResourceHelper(documentHash.data);
25
- }
26
- if (Array.isArray(documentHash.included)) {
27
- const ret = [];
28
- for (let i = 0; i < documentHash.included.length; i++) {
29
- const included = documentHash.included[i];
30
- const normalized = this._normalizeResourceHelper(included);
31
- if (normalized !== null) {
32
- // @ts-expect-error untyped
33
- // can be null when unknown type is encountered
34
- ret.push(normalized);
35
- }
36
- }
37
- documentHash.included = ret;
38
- }
39
- return documentHash;
40
- },
41
- /**
42
- @private
43
- */
44
- _normalizeRelationshipDataHelper(relationshipDataHash) {
45
- relationshipDataHash.type = this.modelNameFromPayloadKey(relationshipDataHash.type);
46
- return relationshipDataHash;
47
- },
48
- /**
49
- @private
50
- */
51
- _normalizeResourceHelper(resourceHash) {
52
- // @ts-expect-error untyped
53
- macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
54
- if (!test) {
55
- throw new Error(this.warnMessageForUndefinedType());
56
- }
57
- })(resourceHash.type) : {};
58
- const type = this.modelNameFromPayloadKey(resourceHash.type);
6
+ //#region src/serializer/json-api.ts
7
+ /**
8
+ * :::danger
9
+ ⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
10
+ If starting a new app or thinking of implementing a new adapter, consider writing a
11
+ {@link Handler} instead to be used with the {@link RequestManager}
12
+ :::
59
13
 
60
- // @ts-expect-error store is dynamically added
61
- if (!this.store.schema.hasResource({
62
- type
63
- })) {
64
- if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
65
- // @ts-expect-error untyped
66
- warn(this.warnMessageNoModelForType(type, resourceHash.type, 'modelNameFromPayloadKey'), false, {
67
- id: 'ds.serializer.model-for-type-missing'
68
- });
69
- }
70
- return null;
71
- }
14
+ In WarpDrive a Serializer is used to serialize and deserialize
15
+ records when they are transferred in and out of an external source.
16
+ This process involves normalizing property names, transforming
17
+ attribute values and serializing relationships.
72
18
 
73
- // @ts-expect-error store is dynamically added
74
- const modelClass = this.store.modelFor(type);
75
- // @ts-expect-error store is dynamically added
76
- const serializer = this.store.serializerFor(type);
77
- const {
78
- data
79
- } = serializer.normalize(modelClass, resourceHash);
80
- return data;
81
- },
82
- /**
83
- Normalize some data and push it into the store.
84
- @public
85
- */
86
- pushPayload(store, payload) {
87
- const normalizedPayload = this._normalizeDocumentHelper(payload);
88
- store.push(normalizedPayload);
89
- },
90
- /**
91
- @return A {json:api} Document
92
- @private
93
- */
94
- _normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
95
- const normalizedPayload = this._normalizeDocumentHelper(payload);
96
- return normalizedPayload;
97
- },
98
- normalizeQueryRecordResponse() {
99
- // @ts-expect-error untyped
100
- const normalized = this._super(...arguments);
101
- macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
102
- if (!test) {
103
- throw new Error('Expected the primary data returned by the serializer for a `queryRecord` response to be a single object but instead it was an array.');
104
- }
105
- })(!Array.isArray(normalized.data)) : {};
106
- return normalized;
107
- },
108
- extractAttributes(modelClass, resourceHash) {
109
- const attributes = {};
110
- if (resourceHash.attributes) {
111
- modelClass.eachAttribute(key => {
112
- const attributeKey = this.keyForAttribute(key, 'deserialize');
113
- if (resourceHash.attributes[attributeKey] !== undefined) {
114
- attributes[key] = resourceHash.attributes[attributeKey];
115
- }
116
- if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
117
- if (resourceHash.attributes[attributeKey] === undefined && resourceHash.attributes[key] !== undefined) {
118
- macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
119
- {
120
- throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${attributeKey}'. This is most likely because Ember Data's JSON API serializer dasherizes attribute keys by default. You should subclass JSONAPISerializer and implement 'keyForAttribute(key) { return key; }' to prevent Ember Data from customizing your attribute keys.`);
121
- }
122
- })() : {};
123
- }
124
- }
125
- });
126
- }
127
- return attributes;
128
- },
129
- /**
130
- Returns a relationship formatted as a JSON-API "relationship object".
131
- http://jsonapi.org/format/#document-resource-object-relationships
132
- @public
133
- */
134
- extractRelationship(relationshipHash) {
135
- if (Array.isArray(relationshipHash.data)) {
136
- const ret = new Array(relationshipHash.data.length);
137
- for (let i = 0; i < relationshipHash.data.length; i++) {
138
- const data = relationshipHash.data[i];
139
- ret[i] = this._normalizeRelationshipDataHelper(data);
140
- }
141
- relationshipHash.data = ret;
142
- } else if (relationshipHash.data && typeof relationshipHash.data === 'object') {
143
- relationshipHash.data = this._normalizeRelationshipDataHelper(relationshipHash.data);
144
- }
145
- return relationshipHash;
146
- },
147
- /**
148
- Returns the resource's relationships formatted as a JSON-API "relationships object".
149
- http://jsonapi.org/format/#document-resource-object-relationships
150
- @public
151
- */
152
- extractRelationships(modelClass, resourceHash) {
153
- const relationships = {};
154
- if (resourceHash.relationships) {
155
- modelClass.eachRelationship((key, relationshipMeta) => {
156
- const relationshipKey = this.keyForRelationship(key, relationshipMeta.kind, 'deserialize');
157
- if (resourceHash.relationships[relationshipKey] !== undefined) {
158
- const relationshipHash = resourceHash.relationships[relationshipKey];
159
- relationships[key] = this.extractRelationship(relationshipHash);
160
- }
161
- if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
162
- if (resourceHash.relationships[relationshipKey] === undefined && resourceHash.relationships[key] !== undefined) {
163
- macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
164
- {
165
- throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${relationshipKey}'. This is most likely because Ember Data's JSON API serializer dasherizes relationship keys by default. You should subclass JSONAPISerializer and implement 'keyForRelationship(key) { return key; }' to prevent Ember Data from customizing your relationship keys.`);
166
- }
167
- })() : {};
168
- }
169
- }
170
- });
171
- }
172
- return relationships;
173
- },
174
- /**
175
- @private
176
- */
177
- _extractType(modelClass, resourceHash) {
178
- return this.modelNameFromPayloadKey(resourceHash.type);
179
- },
180
- /**
181
- Dasherizes and singularizes the model name in the payload to match
182
- the common convention for model names.
183
- For example the key `posts` would be converted to `post` and the
184
- key `studentAssesments` would be converted to `student-assesment`.
185
- @public
186
- @return the model's modelName
187
- */
188
- modelNameFromPayloadKey(key) {
189
- return dasherize(singularize(key));
190
- },
191
- /**
192
- Converts the model name to a pluralized version of the model name.
193
- For example `post` would be converted to `posts` and
194
- `student-assesment` would be converted to `student-assesments`.
195
- @public
196
- */
197
- payloadKeyFromModelName(modelName) {
198
- return pluralize(modelName);
199
- },
200
- normalize(modelClass, resourceHash) {
201
- if (resourceHash.attributes) {
202
- // @ts-expect-error untyped
203
- this.normalizeUsingDeclaredMapping(modelClass, resourceHash.attributes);
204
- }
205
- if (resourceHash.relationships) {
206
- // @ts-expect-error untyped
207
- this.normalizeUsingDeclaredMapping(modelClass, resourceHash.relationships);
208
- }
209
- const data = {
210
- // @ts-expect-error untyped
211
- id: this.extractId(modelClass, resourceHash),
212
- type: this._extractType(modelClass, resourceHash),
213
- attributes: this.extractAttributes(modelClass, resourceHash),
214
- relationships: this.extractRelationships(modelClass, resourceHash)
215
- };
216
- if (resourceHash.lid) {
217
- // @ts-expect-error untyped
218
- data.lid = resourceHash.lid;
219
- }
19
+ `JSONAPISerializer` supports the http://jsonapi.org/ spec, though
20
+ even compliant {json:api} servers may find writing an application
21
+ specific serializer better suited to their needs and more performant.
220
22
 
221
- // @ts-expect-error untyped
222
- this.applyTransforms(modelClass, data.attributes);
223
- return {
224
- data
225
- };
226
- },
227
- /**
228
- `keyForAttribute` can be used to define rules for how to convert an
229
- attribute name in your model to a key in your JSON.
230
- By default `JSONAPISerializer` follows the format used on the examples of
231
- http://jsonapi.org/format and uses dashes as the word separator in the JSON
232
- attribute keys.
233
- This behaviour can be easily customized by extending this method.
234
- Example
235
- ```js [app/serializers/application.js]
236
- import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
237
- import { dasherize } from '<app-name>/utils/string-utils';
238
- export default class ApplicationSerializer extends JSONAPISerializer {
239
- keyForAttribute(attr, method) {
240
- return dasherize(attr).toUpperCase();
241
- }
242
- }
243
- ```
244
- @public
245
- @return normalized key
246
- */
247
- keyForAttribute(key, method) {
248
- return dasherize(key);
249
- },
250
- /**
251
- `keyForRelationship` can be used to define a custom key when
252
- serializing and deserializing relationship properties.
253
- By default `JSONAPISerializer` follows the format used on the examples of
254
- http://jsonapi.org/format and uses dashes as word separators in
255
- relationship properties.
256
- This behaviour can be easily customized by extending this method.
257
- Example
258
- ```js [app/serializers/post.js]
259
- import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
260
- import { underscore } from '<app-name>/utils/string-utils';
261
- export default class ApplicationSerializer extends JSONAPISerializer {
262
- keyForRelationship(key, relationship, method) {
263
- return underscore(key);
264
- }
265
- }
266
- ```
267
- @public
268
- @return the normalized key
269
- */
270
- keyForRelationship(key, typeClass, method) {
271
- return dasherize(key);
272
- },
273
- /**
274
- Called when a record is saved in order to convert the
275
- record into JSON.
276
- For example, consider this model:
277
- ```js [app/models/comment.js]
278
- import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
279
- export default class CommentModel extends Model {
280
- @attr title;
281
- @attr body;
282
- @belongsTo('user', { async: false, inverse: null })
283
- author;
284
- }
285
- ```
286
- The default serialization would create a JSON-API resource object like:
287
- ```javascript
288
- {
289
- "data": {
290
- "type": "comments",
291
- "attributes": {
292
- "title": "Rails is unagi",
293
- "body": "Rails? Omakase? O_O",
294
- },
295
- "relationships": {
296
- "author": {
297
- "data": {
298
- "id": "12",
299
- "type": "users"
300
- }
301
- }
302
- }
303
- }
304
- }
305
- ```
306
- By default, attributes are passed through as-is, unless
307
- you specified an attribute type (`attr('date')`). If
308
- you specify a transform, the JavaScript value will be
309
- serialized when inserted into the attributes hash.
310
- Belongs-to relationships are converted into JSON-API
311
- resource identifier objects.
312
- ## IDs
313
- `serialize` takes an options hash with a single option:
314
- `includeId`. If this option is `true`, `serialize` will,
315
- by default include the ID in the JSON object it builds.
316
- The JSONAPIAdapter passes in `includeId: true` when serializing a record
317
- for `createRecord` or `updateRecord`.
318
- ## Customization
319
- Your server may expect data in a different format than the
320
- built-in serialization format.
321
- In that case, you can implement `serialize` yourself and
322
- return data formatted to match your API's expectations, or override
323
- the invoked adapter method and do the serialization in the adapter directly
324
- by using the provided snapshot.
325
- If your API's format differs greatly from the JSON:API spec, you should
326
- consider authoring your own adapter and serializer instead of extending
327
- this class.
328
- ```js [app/serializers/post.js]
329
- import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
330
- export default class PostSerializer extends JSONAPISerializer {
331
- serialize(snapshot, options) {
332
- let json = {
333
- POST_TTL: snapshot.attr('title'),
334
- POST_BDY: snapshot.attr('body'),
335
- POST_CMS: snapshot.hasMany('comments', { ids: true })
336
- };
337
- if (options.includeId) {
338
- json.POST_ID_ = snapshot.id;
339
- }
340
- return json;
341
- }
342
- }
343
- ```
344
- ## Customizing an App-Wide Serializer
345
- If you want to define a serializer for your entire
346
- application, you'll probably want to use `eachAttribute`
347
- and `eachRelationship` on the record.
348
- ```js [app/serializers/application.js]
349
- import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
350
- import { underscore, singularize } from '<app-name>/utils/string-utils';
351
- export default class ApplicationSerializer extends JSONAPISerializer {
352
- serialize(snapshot, options) {
353
- let json = {};
354
- snapshot.eachAttribute((name) => {
355
- json[serverAttributeName(name)] = snapshot.attr(name);
356
- });
357
- snapshot.eachRelationship((name, relationship) => {
358
- if (relationship.kind === 'hasMany') {
359
- json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
360
- }
361
- });
362
- if (options.includeId) {
363
- json.ID_ = snapshot.id;
364
- }
365
- return json;
366
- }
367
- }
368
- function serverAttributeName(attribute) {
369
- return underscore(attribute).toUpperCase();
370
- }
371
- function serverHasManyName(name) {
372
- return serverAttributeName(singularize(name)) + '_IDS';
373
- }
374
- ```
375
- This serializer will generate JSON that looks like this:
376
- ```javascript
377
- {
378
- "TITLE": "Rails is omakase",
379
- "BODY": "Yep. Omakase.",
380
- "COMMENT_IDS": [ "1", "2", "3" ]
381
- }
382
- ```
383
- ## Tweaking the Default Formatting
384
- If you just want to do some small tweaks on the default JSON:API formatted response,
385
- you can call `super.serialize` first and make the tweaks
386
- on the returned object.
387
- ```js [app/serializers/post.js]
388
- import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
389
- export default class PostSerializer extends JSONAPISerializer {
390
- serialize(snapshot, options) {
391
- let json = super.serialize(...arguments);
392
- json.data.attributes.subject = json.data.attributes.title;
393
- delete json.data.attributes.title;
394
- return json;
395
- }
396
- }
397
- ```
398
- @public
399
- */
400
- serialize(snapshot, options) {
401
- // @ts-expect-error untyped
402
- const data = this._super(...arguments);
403
- data.type = this.payloadKeyFromModelName(snapshot.modelName);
404
- return {
405
- data
406
- };
407
- },
408
- serializeAttribute(snapshot, json, key, attribute) {
409
- const type = attribute.type;
23
+ This serializer normalizes a JSON API payload that looks like:
410
24
 
411
- // @ts-expect-error untyped
412
- if (this._canSerialize(key)) {
413
- json.attributes = json.attributes || {};
414
- let value = snapshot.attr(key);
415
- if (type) {
416
- // @ts-expect-error untyped
417
- const transform = this.transformFor(type);
418
- value = transform.serialize(value, attribute.options);
419
- }
25
+ ```js [app/models/player.js]
26
+ import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
420
27
 
421
- // @ts-expect-error store is dynamically added
422
- const schema = this.store.modelFor(snapshot.modelName);
423
- // @ts-expect-error untyped
424
- let payloadKey = this._getMappedKey(key, schema);
425
- if (payloadKey === key) {
426
- payloadKey = this.keyForAttribute(key, 'serialize');
427
- }
428
- json.attributes[payloadKey] = value;
429
- }
430
- },
431
- serializeBelongsTo(snapshot, json, relationship) {
432
- const name = relationship.name;
28
+ export default class Player extends Model {
29
+ @attr('string') name;
30
+ @attr('string') skill;
31
+ @attr('number') gamesPlayed;
32
+ @belongsTo('club') club;
33
+ }
34
+ ```
433
35
 
434
- // @ts-expect-error untyped
435
- if (this._canSerialize(name)) {
436
- const belongsTo = snapshot.belongsTo(name);
437
- // @ts-expect-error not narrowed
438
- const belongsToIsNotNew = belongsTo && !belongsTo.isNew;
439
- if (belongsTo === null || belongsToIsNotNew) {
440
- json.relationships = json.relationships || {};
36
+ ```js [app/models/club.js]
37
+ import Model, { attr, hasMany } from '@warp-drive/legacy/model';
441
38
 
442
- // @ts-expect-error store is dynamically added
443
- const schema = this.store.modelFor(snapshot.modelName);
444
- // @ts-expect-error untyped
445
- let payloadKey = this._getMappedKey(name, schema);
446
- if (payloadKey === name) {
447
- payloadKey = this.keyForRelationship(name, 'belongsTo', 'serialize');
448
- }
449
- let data = null;
450
- if (belongsTo) {
451
- // @ts-expect-error not narrowed
452
- const payloadType = this.payloadKeyFromModelName(belongsTo.modelName);
39
+ export default class Club extends Model {
40
+ @attr('string') name;
41
+ @attr('string') location;
42
+ @hasMany('player') players;
43
+ }
44
+ ```
453
45
 
454
- // @ts-expect-error untyped
455
- data = {
456
- type: payloadType,
457
- // @ts-expect-error not narrowed
458
- id: belongsTo.id
459
- };
460
- }
461
- json.relationships[payloadKey] = {
462
- data
463
- };
464
- }
465
- }
466
- },
467
- serializeHasMany(snapshot, json, relationship) {
468
- const name = relationship.name;
46
+ ```js
47
+ {
48
+ "data": [
49
+ {
50
+ "attributes": {
51
+ "name": "Benfica",
52
+ "location": "Portugal"
53
+ },
54
+ "id": "1",
55
+ "relationships": {
56
+ "players": {
57
+ "data": [
58
+ {
59
+ "id": "3",
60
+ "type": "players"
61
+ }
62
+ ]
63
+ }
64
+ },
65
+ "type": "clubs"
66
+ }
67
+ ],
68
+ "included": [
69
+ {
70
+ "attributes": {
71
+ "name": "Eusebio Silva Ferreira",
72
+ "skill": "Rocket shot",
73
+ "games-played": 431
74
+ },
75
+ "id": "3",
76
+ "relationships": {
77
+ "club": {
78
+ "data": {
79
+ "id": "1",
80
+ "type": "clubs"
81
+ }
82
+ }
83
+ },
84
+ "type": "players"
85
+ }
86
+ ]
87
+ }
88
+ ```
469
89
 
470
- // @ts-expect-error untyped
471
- if (this.shouldSerializeHasMany(snapshot, name, relationship)) {
472
- const hasMany = snapshot.hasMany(name);
473
- if (hasMany !== undefined) {
474
- json.relationships = json.relationships || {};
90
+ to the format that the JSONAPICache expects.
475
91
 
476
- // @ts-expect-error store is dynamically added
477
- const schema = this.store.modelFor(snapshot.modelName);
478
- // @ts-expect-error untyped
479
- let payloadKey = this._getMappedKey(name, schema);
480
- if (payloadKey === name && this.keyForRelationship) {
481
- payloadKey = this.keyForRelationship(name, 'hasMany', 'serialize');
482
- }
92
+ ### Customizing meta
483
93
 
484
- // only serialize has many relationships that are not new
485
- // @ts-expect-error not narrowed
486
- const nonNewHasMany = hasMany.filter(item => !item.isNew);
487
- const data = new Array(nonNewHasMany.length);
488
- for (let i = 0; i < nonNewHasMany.length; i++) {
489
- const item = hasMany[i];
490
- // @ts-expect-error not narrowed
491
- const payloadType = this.payloadKeyFromModelName(item.modelName);
492
- data[i] = {
493
- type: payloadType,
494
- // @ts-expect-error not narrowed
495
- id: item.id
496
- };
497
- }
498
- json.relationships[payloadKey] = {
499
- data
500
- };
501
- }
502
- }
503
- }
504
- });
505
- if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
506
- JSONAPISerializer.reopen({
507
- init(...args) {
508
- this._super(...args);
509
- macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
510
- if (!test) {
511
- throw new Error(`You've used the EmbeddedRecordsMixin in ${this.toString()} which is not fully compatible with the JSON:API specification. Please confirm that this works for your specific API and add \`this.isEmbeddedRecordsMixinCompatible = true\` to your serializer.`);
512
- }
513
- })(!this.isEmbeddedRecordsMixin || this.isEmbeddedRecordsMixinCompatible === true) : {};
514
- const constructor = this.constructor;
515
- warn(`You've defined 'extractMeta' in ${constructor.toString()} which is not used for serializers extending JSONAPISerializer. Read more at https://api.emberjs.com/ember-data/release/classes/JSONAPISerializer on how to customize meta when using JSON API.`, this.extractMeta === JSONSerializer.prototype.extractMeta, {
516
- id: 'ds.serializer.json-api.extractMeta'
517
- });
518
- },
519
- warnMessageForUndefinedType() {
520
- return 'Encountered a resource object with an undefined type (resolved resource using ' + this.constructor.toString() + ')';
521
- },
522
- warnMessageNoModelForType(modelName, originalType, usedLookup) {
523
- return `Encountered a resource object with type "${originalType}", but no model was found for model name "${modelName}" (resolved model name using '${this.constructor.toString()}.${usedLookup}("${originalType}")').`;
524
- }
525
- });
94
+ Since a JSON API Document can have meta defined in multiple locations you can
95
+ use the specific serializer hooks if you need to customize the meta.
96
+
97
+ One scenario would be to camelCase the meta keys of your payload. The example
98
+ below shows how this could be done using `normalizeArrayResponse` and
99
+ `extractRelationship`.
100
+
101
+ ```js [app/serializers/application.js]
102
+ import { JSONAPISerializer } from '@warp-drive/legacy/serializer/json-api';
103
+
104
+ export default class ApplicationSerializer extends JSONAPISerializer {
105
+ normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) {
106
+ let normalizedDocument = super.normalizeArrayResponse(...arguments);
107
+
108
+ // Customize document meta
109
+ normalizedDocument.meta = camelCaseKeys(normalizedDocument.meta);
110
+
111
+ return normalizedDocument;
112
+ }
113
+
114
+ extractRelationship(relationshipHash) {
115
+ let normalizedRelationship = super.extractRelationship(...arguments);
116
+
117
+ // Customize relationship meta
118
+ normalizedRelationship.meta = camelCaseKeys(normalizedRelationship.meta);
119
+
120
+ return normalizedRelationship;
526
121
  }
527
- export { JSONAPISerializer };
122
+ }
123
+ ```
124
+
125
+ @since 1.13.0
126
+ @class JSONAPISerializer
127
+ @public
128
+ */
129
+ const JSONAPISerializer = JSONSerializer.extend({
130
+ /**
131
+ @private
132
+ */
133
+ _normalizeDocumentHelper(documentHash) {
134
+ if (Array.isArray(documentHash.data)) {
135
+ const ret = [];
136
+ for (let i = 0; i < documentHash.data.length; i++) {
137
+ const data = documentHash.data[i];
138
+ const normalized = this._normalizeResourceHelper(data);
139
+ if (normalized !== null) ret.push(normalized);
140
+ }
141
+ documentHash.data = ret;
142
+ } else if (documentHash.data && typeof documentHash.data === "object") documentHash.data = this._normalizeResourceHelper(documentHash.data);
143
+ if (Array.isArray(documentHash.included)) {
144
+ const ret = [];
145
+ for (let i = 0; i < documentHash.included.length; i++) {
146
+ const included = documentHash.included[i];
147
+ const normalized = this._normalizeResourceHelper(included);
148
+ if (normalized !== null) ret.push(normalized);
149
+ }
150
+ documentHash.included = ret;
151
+ }
152
+ return documentHash;
153
+ },
154
+ /**
155
+ @private
156
+ */
157
+ _normalizeRelationshipDataHelper(relationshipDataHash) {
158
+ relationshipDataHash.type = this.modelNameFromPayloadKey(relationshipDataHash.type);
159
+ return relationshipDataHash;
160
+ },
161
+ /**
162
+ @private
163
+ */
164
+ _normalizeResourceHelper(resourceHash) {
165
+ macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
166
+ if (!test) throw new Error(this.warnMessageForUndefinedType());
167
+ })(resourceHash.type);
168
+ const type = this.modelNameFromPayloadKey(resourceHash.type);
169
+ if (!this.store.schema.hasResource({ type })) {
170
+ if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) warn(this.warnMessageNoModelForType(type, resourceHash.type, "modelNameFromPayloadKey"), false, { id: "ds.serializer.model-for-type-missing" });
171
+ return null;
172
+ }
173
+ const modelClass = this.store.modelFor(type);
174
+ const { data } = this.store.serializerFor(type).normalize(modelClass, resourceHash);
175
+ return data;
176
+ },
177
+ /**
178
+ Normalize some data and push it into the store.
179
+ @public
180
+ */
181
+ pushPayload(store, payload) {
182
+ const normalizedPayload = this._normalizeDocumentHelper(payload);
183
+ store.push(normalizedPayload);
184
+ },
185
+ /**
186
+ @return A {json:api} Document
187
+ @private
188
+ */
189
+ _normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
190
+ return this._normalizeDocumentHelper(payload);
191
+ },
192
+ normalizeQueryRecordResponse() {
193
+ const normalized = this._super(...arguments);
194
+ macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
195
+ if (!test) throw new Error("Expected the primary data returned by the serializer for a `queryRecord` response to be a single object but instead it was an array.");
196
+ })(!Array.isArray(normalized.data));
197
+ return normalized;
198
+ },
199
+ extractAttributes(modelClass, resourceHash) {
200
+ const attributes = {};
201
+ if (resourceHash.attributes) modelClass.eachAttribute((key) => {
202
+ const attributeKey = this.keyForAttribute(key, "deserialize");
203
+ if (resourceHash.attributes[attributeKey] !== void 0) attributes[key] = resourceHash.attributes[attributeKey];
204
+ if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
205
+ if (resourceHash.attributes[attributeKey] === void 0 && resourceHash.attributes[key] !== void 0) macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
206
+ if (!test) throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${attributeKey}'. This is most likely because Ember Data's JSON API serializer dasherizes attribute keys by default. You should subclass JSONAPISerializer and implement 'keyForAttribute(key) { return key; }' to prevent Ember Data from customizing your attribute keys.`);
207
+ })(false);
208
+ }
209
+ });
210
+ return attributes;
211
+ },
212
+ /**
213
+ Returns a relationship formatted as a JSON-API "relationship object".
214
+ http://jsonapi.org/format/#document-resource-object-relationships
215
+ @public
216
+ */
217
+ extractRelationship(relationshipHash) {
218
+ if (Array.isArray(relationshipHash.data)) {
219
+ const ret = new Array(relationshipHash.data.length);
220
+ for (let i = 0; i < relationshipHash.data.length; i++) {
221
+ const data = relationshipHash.data[i];
222
+ ret[i] = this._normalizeRelationshipDataHelper(data);
223
+ }
224
+ relationshipHash.data = ret;
225
+ } else if (relationshipHash.data && typeof relationshipHash.data === "object") relationshipHash.data = this._normalizeRelationshipDataHelper(relationshipHash.data);
226
+ return relationshipHash;
227
+ },
228
+ /**
229
+ Returns the resource's relationships formatted as a JSON-API "relationships object".
230
+ http://jsonapi.org/format/#document-resource-object-relationships
231
+ @public
232
+ */
233
+ extractRelationships(modelClass, resourceHash) {
234
+ const relationships = {};
235
+ if (resourceHash.relationships) modelClass.eachRelationship((key, relationshipMeta) => {
236
+ const relationshipKey = this.keyForRelationship(key, relationshipMeta.kind, "deserialize");
237
+ if (resourceHash.relationships[relationshipKey] !== void 0) {
238
+ const relationshipHash = resourceHash.relationships[relationshipKey];
239
+ relationships[key] = this.extractRelationship(relationshipHash);
240
+ }
241
+ if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
242
+ if (resourceHash.relationships[relationshipKey] === void 0 && resourceHash.relationships[key] !== void 0) macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
243
+ if (!test) throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${relationshipKey}'. This is most likely because Ember Data's JSON API serializer dasherizes relationship keys by default. You should subclass JSONAPISerializer and implement 'keyForRelationship(key) { return key; }' to prevent Ember Data from customizing your relationship keys.`);
244
+ })(false);
245
+ }
246
+ });
247
+ return relationships;
248
+ },
249
+ /**
250
+ @private
251
+ */
252
+ _extractType(modelClass, resourceHash) {
253
+ return this.modelNameFromPayloadKey(resourceHash.type);
254
+ },
255
+ /**
256
+ Dasherizes and singularizes the model name in the payload to match
257
+ the common convention for model names.
258
+ For example the key `posts` would be converted to `post` and the
259
+ key `studentAssesments` would be converted to `student-assesment`.
260
+ @public
261
+ @return the model's modelName
262
+ */
263
+ modelNameFromPayloadKey(key) {
264
+ return dasherize(singularize(key));
265
+ },
266
+ /**
267
+ Converts the model name to a pluralized version of the model name.
268
+ For example `post` would be converted to `posts` and
269
+ `student-assesment` would be converted to `student-assesments`.
270
+ @public
271
+ */
272
+ payloadKeyFromModelName(modelName) {
273
+ return pluralize(modelName);
274
+ },
275
+ normalize(modelClass, resourceHash) {
276
+ if (resourceHash.attributes) this.normalizeUsingDeclaredMapping(modelClass, resourceHash.attributes);
277
+ if (resourceHash.relationships) this.normalizeUsingDeclaredMapping(modelClass, resourceHash.relationships);
278
+ const data = {
279
+ id: this.extractId(modelClass, resourceHash),
280
+ type: this._extractType(modelClass, resourceHash),
281
+ attributes: this.extractAttributes(modelClass, resourceHash),
282
+ relationships: this.extractRelationships(modelClass, resourceHash)
283
+ };
284
+ if (resourceHash.lid) data.lid = resourceHash.lid;
285
+ this.applyTransforms(modelClass, data.attributes);
286
+ return { data };
287
+ },
288
+ /**
289
+ `keyForAttribute` can be used to define rules for how to convert an
290
+ attribute name in your model to a key in your JSON.
291
+ By default `JSONAPISerializer` follows the format used on the examples of
292
+ http://jsonapi.org/format and uses dashes as the word separator in the JSON
293
+ attribute keys.
294
+ This behaviour can be easily customized by extending this method.
295
+ Example
296
+ ```js [app/serializers/application.js]
297
+ import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
298
+ import { dasherize } from '<app-name>/utils/string-utils';
299
+ export default class ApplicationSerializer extends JSONAPISerializer {
300
+ keyForAttribute(attr, method) {
301
+ return dasherize(attr).toUpperCase();
302
+ }
303
+ }
304
+ ```
305
+ @public
306
+ @return normalized key
307
+ */
308
+ keyForAttribute(key, method) {
309
+ return dasherize(key);
310
+ },
311
+ /**
312
+ `keyForRelationship` can be used to define a custom key when
313
+ serializing and deserializing relationship properties.
314
+ By default `JSONAPISerializer` follows the format used on the examples of
315
+ http://jsonapi.org/format and uses dashes as word separators in
316
+ relationship properties.
317
+ This behaviour can be easily customized by extending this method.
318
+ Example
319
+ ```js [app/serializers/post.js]
320
+ import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
321
+ import { underscore } from '<app-name>/utils/string-utils';
322
+ export default class ApplicationSerializer extends JSONAPISerializer {
323
+ keyForRelationship(key, relationship, method) {
324
+ return underscore(key);
325
+ }
326
+ }
327
+ ```
328
+ @public
329
+ @return the normalized key
330
+ */
331
+ keyForRelationship(key, typeClass, method) {
332
+ return dasherize(key);
333
+ },
334
+ /**
335
+ Called when a record is saved in order to convert the
336
+ record into JSON.
337
+ For example, consider this model:
338
+ ```js [app/models/comment.js]
339
+ import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
340
+ export default class CommentModel extends Model {
341
+ @attr title;
342
+ @attr body;
343
+ @belongsTo('user', { async: false, inverse: null })
344
+ author;
345
+ }
346
+ ```
347
+ The default serialization would create a JSON-API resource object like:
348
+ ```javascript
349
+ {
350
+ "data": {
351
+ "type": "comments",
352
+ "attributes": {
353
+ "title": "Rails is unagi",
354
+ "body": "Rails? Omakase? O_O",
355
+ },
356
+ "relationships": {
357
+ "author": {
358
+ "data": {
359
+ "id": "12",
360
+ "type": "users"
361
+ }
362
+ }
363
+ }
364
+ }
365
+ }
366
+ ```
367
+ By default, attributes are passed through as-is, unless
368
+ you specified an attribute type (`attr('date')`). If
369
+ you specify a transform, the JavaScript value will be
370
+ serialized when inserted into the attributes hash.
371
+ Belongs-to relationships are converted into JSON-API
372
+ resource identifier objects.
373
+ ## IDs
374
+ `serialize` takes an options hash with a single option:
375
+ `includeId`. If this option is `true`, `serialize` will,
376
+ by default include the ID in the JSON object it builds.
377
+ The JSONAPIAdapter passes in `includeId: true` when serializing a record
378
+ for `createRecord` or `updateRecord`.
379
+ ## Customization
380
+ Your server may expect data in a different format than the
381
+ built-in serialization format.
382
+ In that case, you can implement `serialize` yourself and
383
+ return data formatted to match your API's expectations, or override
384
+ the invoked adapter method and do the serialization in the adapter directly
385
+ by using the provided snapshot.
386
+ If your API's format differs greatly from the JSON:API spec, you should
387
+ consider authoring your own adapter and serializer instead of extending
388
+ this class.
389
+ ```js [app/serializers/post.js]
390
+ import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
391
+ export default class PostSerializer extends JSONAPISerializer {
392
+ serialize(snapshot, options) {
393
+ let json = {
394
+ POST_TTL: snapshot.attr('title'),
395
+ POST_BDY: snapshot.attr('body'),
396
+ POST_CMS: snapshot.hasMany('comments', { ids: true })
397
+ };
398
+ if (options.includeId) {
399
+ json.POST_ID_ = snapshot.id;
400
+ }
401
+ return json;
402
+ }
403
+ }
404
+ ```
405
+ ## Customizing an App-Wide Serializer
406
+ If you want to define a serializer for your entire
407
+ application, you'll probably want to use `eachAttribute`
408
+ and `eachRelationship` on the record.
409
+ ```js [app/serializers/application.js]
410
+ import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
411
+ import { underscore, singularize } from '<app-name>/utils/string-utils';
412
+ export default class ApplicationSerializer extends JSONAPISerializer {
413
+ serialize(snapshot, options) {
414
+ let json = {};
415
+ snapshot.eachAttribute((name) => {
416
+ json[serverAttributeName(name)] = snapshot.attr(name);
417
+ });
418
+ snapshot.eachRelationship((name, relationship) => {
419
+ if (relationship.kind === 'hasMany') {
420
+ json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
421
+ }
422
+ });
423
+ if (options.includeId) {
424
+ json.ID_ = snapshot.id;
425
+ }
426
+ return json;
427
+ }
428
+ }
429
+ function serverAttributeName(attribute) {
430
+ return underscore(attribute).toUpperCase();
431
+ }
432
+ function serverHasManyName(name) {
433
+ return serverAttributeName(singularize(name)) + '_IDS';
434
+ }
435
+ ```
436
+ This serializer will generate JSON that looks like this:
437
+ ```javascript
438
+ {
439
+ "TITLE": "Rails is omakase",
440
+ "BODY": "Yep. Omakase.",
441
+ "COMMENT_IDS": [ "1", "2", "3" ]
442
+ }
443
+ ```
444
+ ## Tweaking the Default Formatting
445
+ If you just want to do some small tweaks on the default JSON:API formatted response,
446
+ you can call `super.serialize` first and make the tweaks
447
+ on the returned object.
448
+ ```js [app/serializers/post.js]
449
+ import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
450
+ export default class PostSerializer extends JSONAPISerializer {
451
+ serialize(snapshot, options) {
452
+ let json = super.serialize(...arguments);
453
+ json.data.attributes.subject = json.data.attributes.title;
454
+ delete json.data.attributes.title;
455
+ return json;
456
+ }
457
+ }
458
+ ```
459
+ @public
460
+ */
461
+ serialize(snapshot, options) {
462
+ const data = this._super(...arguments);
463
+ data.type = this.payloadKeyFromModelName(snapshot.modelName);
464
+ return { data };
465
+ },
466
+ serializeAttribute(snapshot, json, key, attribute) {
467
+ const type = attribute.type;
468
+ if (this._canSerialize(key)) {
469
+ json.attributes = json.attributes || {};
470
+ let value = snapshot.attr(key);
471
+ if (type) value = this.transformFor(type).serialize(value, attribute.options);
472
+ const schema = this.store.modelFor(snapshot.modelName);
473
+ let payloadKey = this._getMappedKey(key, schema);
474
+ if (payloadKey === key) payloadKey = this.keyForAttribute(key, "serialize");
475
+ json.attributes[payloadKey] = value;
476
+ }
477
+ },
478
+ serializeBelongsTo(snapshot, json, relationship) {
479
+ const name = relationship.name;
480
+ if (this._canSerialize(name)) {
481
+ const belongsTo = snapshot.belongsTo(name);
482
+ const belongsToIsNotNew = belongsTo && !belongsTo.isNew;
483
+ if (belongsTo === null || belongsToIsNotNew) {
484
+ json.relationships = json.relationships || {};
485
+ const schema = this.store.modelFor(snapshot.modelName);
486
+ let payloadKey = this._getMappedKey(name, schema);
487
+ if (payloadKey === name) payloadKey = this.keyForRelationship(name, "belongsTo", "serialize");
488
+ let data = null;
489
+ if (belongsTo) data = {
490
+ type: this.payloadKeyFromModelName(belongsTo.modelName),
491
+ id: belongsTo.id
492
+ };
493
+ json.relationships[payloadKey] = { data };
494
+ }
495
+ }
496
+ },
497
+ serializeHasMany(snapshot, json, relationship) {
498
+ const name = relationship.name;
499
+ if (this.shouldSerializeHasMany(snapshot, name, relationship)) {
500
+ const hasMany = snapshot.hasMany(name);
501
+ if (hasMany !== void 0) {
502
+ json.relationships = json.relationships || {};
503
+ const schema = this.store.modelFor(snapshot.modelName);
504
+ let payloadKey = this._getMappedKey(name, schema);
505
+ if (payloadKey === name && this.keyForRelationship) payloadKey = this.keyForRelationship(name, "hasMany", "serialize");
506
+ const nonNewHasMany = hasMany.filter((item) => !item.isNew);
507
+ const data = new Array(nonNewHasMany.length);
508
+ for (let i = 0; i < nonNewHasMany.length; i++) {
509
+ const item = hasMany[i];
510
+ const payloadType = this.payloadKeyFromModelName(item.modelName);
511
+ data[i] = {
512
+ type: payloadType,
513
+ id: item.id
514
+ };
515
+ }
516
+ json.relationships[payloadKey] = { data };
517
+ }
518
+ }
519
+ }
520
+ });
521
+ if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) JSONAPISerializer.reopen({
522
+ init(...args) {
523
+ this._super(...args);
524
+ macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
525
+ if (!test) throw new Error(`You've used the EmbeddedRecordsMixin in ${this.toString()} which is not fully compatible with the JSON:API specification. Please confirm that this works for your specific API and add \`this.isEmbeddedRecordsMixinCompatible = true\` to your serializer.`);
526
+ })(!this.isEmbeddedRecordsMixin || this.isEmbeddedRecordsMixinCompatible === true);
527
+ const constructor = this.constructor;
528
+ warn(`You've defined 'extractMeta' in ${constructor.toString()} which is not used for serializers extending JSONAPISerializer. Read more at https://api.emberjs.com/ember-data/release/classes/JSONAPISerializer on how to customize meta when using JSON API.`, this.extractMeta === JSONSerializer.prototype.extractMeta, { id: "ds.serializer.json-api.extractMeta" });
529
+ },
530
+ warnMessageForUndefinedType() {
531
+ return "Encountered a resource object with an undefined type (resolved resource using " + this.constructor.toString() + ")";
532
+ },
533
+ warnMessageNoModelForType(modelName, originalType, usedLookup) {
534
+ return `Encountered a resource object with type "${originalType}", but no model was found for model name "${modelName}" (resolved model name using '${this.constructor.toString()}.${usedLookup}("${originalType}")').`;
535
+ }
536
+ });
537
+
538
+ //#endregion
539
+ export { JSONAPISerializer };
540
+ //# sourceMappingURL=json-api.js.map