@warp-drive/core 5.6.0-alpha.14 → 5.6.0-alpha.17

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 (287) hide show
  1. package/declarations/build-config/babel-macros.d.ts +1 -2
  2. package/declarations/build-config/canary-features.d.ts +1 -2
  3. package/declarations/build-config/debugging.d.ts +1 -2
  4. package/declarations/build-config/deprecations.d.ts +1 -2
  5. package/declarations/build-config/env.d.ts +1 -2
  6. package/declarations/build-config/macros.d.ts +1 -2
  7. package/declarations/build-config.d.ts +1 -2
  8. package/declarations/configure.d.ts +6 -7
  9. package/declarations/graph/-private/-diff.d.ts +21 -22
  10. package/declarations/graph/-private/-edge-definition.d.ts +134 -135
  11. package/declarations/graph/-private/-state.d.ts +93 -7
  12. package/declarations/graph/-private/-utils.d.ts +18 -13
  13. package/declarations/graph/-private/coerce-id.d.ts +6 -1
  14. package/declarations/graph/-private/debug/assert-polymorphic-type.d.ts +15 -4
  15. package/declarations/graph/-private/edges/collection.d.ts +35 -36
  16. package/declarations/graph/-private/edges/implicit.d.ts +28 -29
  17. package/declarations/graph/-private/edges/resource.d.ts +19 -20
  18. package/declarations/graph/-private/graph.d.ts +83 -48
  19. package/declarations/graph/-private/normalize-link.d.ts +7 -2
  20. package/declarations/graph/-private/operations/add-to-related-records.d.ts +3 -4
  21. package/declarations/graph/-private/operations/merge-identifier.d.ts +2 -3
  22. package/declarations/graph/-private/operations/remove-from-related-records.d.ts +3 -4
  23. package/declarations/graph/-private/operations/replace-related-record.d.ts +2 -3
  24. package/declarations/graph/-private/operations/replace-related-records.d.ts +58 -4
  25. package/declarations/graph/-private/operations/update-relationship.d.ts +11 -9
  26. package/declarations/graph/-private.d.ts +9 -10
  27. package/declarations/index.d.ts +11 -12
  28. package/declarations/reactive/-private/document.d.ts +143 -144
  29. package/declarations/reactive/-private/fields/compute.d.ts +31 -28
  30. package/declarations/reactive/-private/fields/extension.d.ts +8 -0
  31. package/declarations/reactive/-private/fields/managed-array.d.ts +19 -20
  32. package/declarations/reactive/-private/fields/managed-object.d.ts +16 -16
  33. package/declarations/reactive/-private/fields/many-array-manager.d.ts +15 -16
  34. package/declarations/reactive/-private/hooks.d.ts +3 -4
  35. package/declarations/reactive/-private/record.d.ts +61 -58
  36. package/declarations/reactive/-private/schema.d.ts +256 -165
  37. package/declarations/reactive/-private/symbols.d.ts +27 -2
  38. package/declarations/reactive/-private.d.ts +1 -2
  39. package/declarations/reactive.d.ts +4 -5
  40. package/declarations/request/-private/context.d.ts +34 -35
  41. package/declarations/request/-private/debug.d.ts +2 -3
  42. package/declarations/request/-private/fetch.d.ts +23 -24
  43. package/declarations/request/-private/future.d.ts +3 -4
  44. package/declarations/request/-private/manager.d.ts +159 -157
  45. package/declarations/request/-private/promise-cache.d.ts +21 -13
  46. package/declarations/request/-private/types.d.ts +124 -124
  47. package/declarations/request/-private/utils.d.ts +8 -9
  48. package/declarations/request.d.ts +5 -6
  49. package/declarations/store/-private/cache-handler/handler.d.ts +57 -52
  50. package/declarations/store/-private/cache-handler/types.d.ts +95 -96
  51. package/declarations/store/-private/cache-handler/utils.d.ts +16 -16
  52. package/declarations/store/-private/caches/cache-utils.d.ts +7 -4
  53. package/declarations/store/-private/caches/identifier-cache.d.ts +234 -246
  54. package/declarations/store/-private/caches/instance-cache.d.ts +47 -47
  55. package/declarations/store/-private/caches/resource-utils.d.ts +3 -4
  56. package/declarations/store/-private/debug/utils.d.ts +6 -7
  57. package/declarations/store/-private/default-cache-policy.d.ts +362 -361
  58. package/declarations/store/-private/legacy-model-support/record-reference.d.ts +154 -159
  59. package/declarations/store/-private/legacy-model-support/shim-model-class.d.ts +14 -14
  60. package/declarations/store/-private/managers/cache-capabilities-manager.d.ts +21 -22
  61. package/declarations/store/-private/managers/cache-manager.d.ts +440 -425
  62. package/declarations/store/-private/managers/notification-manager.d.ts +88 -83
  63. package/declarations/store/-private/managers/record-array-manager.d.ts +89 -90
  64. package/declarations/store/-private/network/request-cache.d.ts +86 -83
  65. package/declarations/store/-private/new-core-tmp/promise-state.d.ts +252 -244
  66. package/declarations/store/-private/new-core-tmp/reactivity/configure.d.ts +155 -72
  67. package/declarations/store/-private/new-core-tmp/reactivity/internal.d.ts +148 -149
  68. package/declarations/store/-private/new-core-tmp/reactivity/signal.d.ts +28 -23
  69. package/declarations/store/-private/new-core-tmp/request-state.d.ts +263 -241
  70. package/declarations/store/-private/new-core-tmp/request-subscription.d.ts +261 -0
  71. package/declarations/store/-private/record-arrays/identifier-array.d.ts +125 -119
  72. package/declarations/store/-private/record-arrays/many-array.d.ts +180 -182
  73. package/declarations/store/-private/record-arrays/native-proxy-type-fix.d.ts +120 -110
  74. package/declarations/store/-private/store-service.d.ts +1594 -1586
  75. package/declarations/store/-private/utils/coerce-id.d.ts +6 -1
  76. package/declarations/store/-private/utils/construct-resource.d.ts +1 -2
  77. package/declarations/store/-private/utils/is-non-empty-string.d.ts +0 -1
  78. package/declarations/store/-private/utils/normalize-model-name.d.ts +0 -1
  79. package/declarations/store/-private/utils/uuid-polyfill.d.ts +0 -1
  80. package/declarations/store/-private.d.ts +31 -27
  81. package/declarations/store/-types/q/cache-capabilities-manager.d.ts +96 -97
  82. package/declarations/store/-types/q/ds-model.d.ts +17 -18
  83. package/declarations/store/-types/q/identifier.d.ts +11 -12
  84. package/declarations/store/-types/q/record-instance.d.ts +16 -17
  85. package/declarations/store/-types/q/schema-service.d.ts +346 -323
  86. package/declarations/store/-types/q/store.d.ts +25 -28
  87. package/declarations/store.d.ts +1 -2
  88. package/declarations/types/-private.d.ts +16 -8
  89. package/declarations/types/cache/aliases.d.ts +11 -1
  90. package/declarations/types/cache/change.d.ts +4 -5
  91. package/declarations/types/cache/mutations.d.ts +51 -28
  92. package/declarations/types/cache/operations.d.ts +60 -47
  93. package/declarations/types/cache/relationship.d.ts +11 -9
  94. package/declarations/types/cache.d.ts +495 -484
  95. package/declarations/types/graph.d.ts +31 -32
  96. package/declarations/types/identifier.d.ts +83 -82
  97. package/declarations/types/json/raw.d.ts +1 -2
  98. package/declarations/types/params.d.ts +4 -5
  99. package/declarations/types/record.d.ts +117 -76
  100. package/declarations/types/request.d.ts +289 -266
  101. package/declarations/types/runtime.d.ts +8 -9
  102. package/declarations/types/schema/concepts.d.ts +19 -13
  103. package/declarations/types/schema/fields.d.ts +1712 -1587
  104. package/declarations/types/schema/fields.type-test.d.ts +0 -1
  105. package/declarations/types/spec/document.d.ts +28 -22
  106. package/declarations/types/spec/error.d.ts +16 -17
  107. package/declarations/types/spec/json-api-raw.d.ts +102 -102
  108. package/declarations/types/symbols.d.ts +74 -75
  109. package/declarations/types/utils.d.ts +5 -5
  110. package/declarations/types.d.ts +10 -11
  111. package/declarations/utils/string.d.ts +43 -40
  112. package/dist/{configure-BgaZESRo.js → configure-B48bFHOl.js} +38 -2
  113. package/dist/configure.js +1 -1
  114. package/dist/graph/-private.js +2 -2
  115. package/dist/{handler-cHghx9Y9.js → handler-C2T-IyJK.js} +1 -1
  116. package/dist/index.js +3 -3
  117. package/dist/reactive/-private.js +1 -1
  118. package/dist/reactive.js +287 -101
  119. package/dist/{request-state-DgwTEXLU.js → request-state-CjLph1LP.js} +1030 -249
  120. package/dist/store/-private.js +3 -3
  121. package/dist/{symbols-BmDcn6hS.js → symbols-SIstXMLI.js} +3 -3
  122. package/dist/types/-private.js +1 -1
  123. package/dist/types/schema/fields.js +4 -4
  124. package/package.json +4 -4
  125. package/declarations/build-config/babel-macros.d.ts.map +0 -1
  126. package/declarations/build-config/canary-features.d.ts.map +0 -1
  127. package/declarations/build-config/debugging.d.ts.map +0 -1
  128. package/declarations/build-config/deprecations.d.ts.map +0 -1
  129. package/declarations/build-config/env.d.ts.map +0 -1
  130. package/declarations/build-config/macros.d.ts.map +0 -1
  131. package/declarations/build-config.d.ts.map +0 -1
  132. package/declarations/configure.d.ts.map +0 -1
  133. package/declarations/graph/-private/-diff.d.ts.map +0 -1
  134. package/declarations/graph/-private/-edge-definition.d.ts.map +0 -1
  135. package/declarations/graph/-private/-state.d.ts.map +0 -1
  136. package/declarations/graph/-private/-utils.d.ts.map +0 -1
  137. package/declarations/graph/-private/coerce-id.d.ts.map +0 -1
  138. package/declarations/graph/-private/debug/assert-polymorphic-type.d.ts.map +0 -1
  139. package/declarations/graph/-private/edges/collection.d.ts.map +0 -1
  140. package/declarations/graph/-private/edges/implicit.d.ts.map +0 -1
  141. package/declarations/graph/-private/edges/resource.d.ts.map +0 -1
  142. package/declarations/graph/-private/graph.d.ts.map +0 -1
  143. package/declarations/graph/-private/normalize-link.d.ts.map +0 -1
  144. package/declarations/graph/-private/operations/add-to-related-records.d.ts.map +0 -1
  145. package/declarations/graph/-private/operations/merge-identifier.d.ts.map +0 -1
  146. package/declarations/graph/-private/operations/remove-from-related-records.d.ts.map +0 -1
  147. package/declarations/graph/-private/operations/replace-related-record.d.ts.map +0 -1
  148. package/declarations/graph/-private/operations/replace-related-records.d.ts.map +0 -1
  149. package/declarations/graph/-private/operations/update-relationship.d.ts.map +0 -1
  150. package/declarations/graph/-private.d.ts.map +0 -1
  151. package/declarations/index.d.ts.map +0 -1
  152. package/declarations/reactive/-private/document.d.ts.map +0 -1
  153. package/declarations/reactive/-private/fields/compute.d.ts.map +0 -1
  154. package/declarations/reactive/-private/fields/managed-array.d.ts.map +0 -1
  155. package/declarations/reactive/-private/fields/managed-object.d.ts.map +0 -1
  156. package/declarations/reactive/-private/fields/many-array-manager.d.ts.map +0 -1
  157. package/declarations/reactive/-private/hooks.d.ts.map +0 -1
  158. package/declarations/reactive/-private/record.d.ts.map +0 -1
  159. package/declarations/reactive/-private/schema.d.ts.map +0 -1
  160. package/declarations/reactive/-private/symbols.d.ts.map +0 -1
  161. package/declarations/reactive/-private.d.ts.map +0 -1
  162. package/declarations/reactive.d.ts.map +0 -1
  163. package/declarations/request/-private/context.d.ts.map +0 -1
  164. package/declarations/request/-private/debug.d.ts.map +0 -1
  165. package/declarations/request/-private/fetch.d.ts.map +0 -1
  166. package/declarations/request/-private/future.d.ts.map +0 -1
  167. package/declarations/request/-private/manager.d.ts.map +0 -1
  168. package/declarations/request/-private/promise-cache.d.ts.map +0 -1
  169. package/declarations/request/-private/types.d.ts.map +0 -1
  170. package/declarations/request/-private/utils.d.ts.map +0 -1
  171. package/declarations/request.d.ts.map +0 -1
  172. package/declarations/store/-private/cache-handler/handler.d.ts.map +0 -1
  173. package/declarations/store/-private/cache-handler/types.d.ts.map +0 -1
  174. package/declarations/store/-private/cache-handler/utils.d.ts.map +0 -1
  175. package/declarations/store/-private/caches/cache-utils.d.ts.map +0 -1
  176. package/declarations/store/-private/caches/identifier-cache.d.ts.map +0 -1
  177. package/declarations/store/-private/caches/instance-cache.d.ts.map +0 -1
  178. package/declarations/store/-private/caches/resource-utils.d.ts.map +0 -1
  179. package/declarations/store/-private/debug/utils.d.ts.map +0 -1
  180. package/declarations/store/-private/default-cache-policy.d.ts.map +0 -1
  181. package/declarations/store/-private/legacy-model-support/record-reference.d.ts.map +0 -1
  182. package/declarations/store/-private/legacy-model-support/shim-model-class.d.ts.map +0 -1
  183. package/declarations/store/-private/managers/cache-capabilities-manager.d.ts.map +0 -1
  184. package/declarations/store/-private/managers/cache-manager.d.ts.map +0 -1
  185. package/declarations/store/-private/managers/notification-manager.d.ts.map +0 -1
  186. package/declarations/store/-private/managers/record-array-manager.d.ts.map +0 -1
  187. package/declarations/store/-private/network/request-cache.d.ts.map +0 -1
  188. package/declarations/store/-private/new-core-tmp/promise-state.d.ts.map +0 -1
  189. package/declarations/store/-private/new-core-tmp/reactivity/configure.d.ts.map +0 -1
  190. package/declarations/store/-private/new-core-tmp/reactivity/internal.d.ts.map +0 -1
  191. package/declarations/store/-private/new-core-tmp/reactivity/signal.d.ts.map +0 -1
  192. package/declarations/store/-private/new-core-tmp/request-state.d.ts.map +0 -1
  193. package/declarations/store/-private/record-arrays/identifier-array.d.ts.map +0 -1
  194. package/declarations/store/-private/record-arrays/many-array.d.ts.map +0 -1
  195. package/declarations/store/-private/record-arrays/native-proxy-type-fix.d.ts.map +0 -1
  196. package/declarations/store/-private/store-service.d.ts.map +0 -1
  197. package/declarations/store/-private/store-service.type-test.d.ts +0 -2
  198. package/declarations/store/-private/store-service.type-test.d.ts.map +0 -1
  199. package/declarations/store/-private/utils/coerce-id.d.ts.map +0 -1
  200. package/declarations/store/-private/utils/construct-resource.d.ts.map +0 -1
  201. package/declarations/store/-private/utils/is-non-empty-string.d.ts.map +0 -1
  202. package/declarations/store/-private/utils/normalize-model-name.d.ts.map +0 -1
  203. package/declarations/store/-private/utils/uuid-polyfill.d.ts.map +0 -1
  204. package/declarations/store/-private.d.ts.map +0 -1
  205. package/declarations/store/-types/q/cache-capabilities-manager.d.ts.map +0 -1
  206. package/declarations/store/-types/q/ds-model.d.ts.map +0 -1
  207. package/declarations/store/-types/q/identifier.d.ts.map +0 -1
  208. package/declarations/store/-types/q/promise-proxies.d.ts +0 -2
  209. package/declarations/store/-types/q/promise-proxies.d.ts.map +0 -1
  210. package/declarations/store/-types/q/record-data-json-api.d.ts +0 -31
  211. package/declarations/store/-types/q/record-data-json-api.d.ts.map +0 -1
  212. package/declarations/store/-types/q/record-instance.d.ts.map +0 -1
  213. package/declarations/store/-types/q/schema-service.d.ts.map +0 -1
  214. package/declarations/store/-types/q/store.d.ts.map +0 -1
  215. package/declarations/store.d.ts.map +0 -1
  216. package/declarations/types/-private.d.ts.map +0 -1
  217. package/declarations/types/cache/aliases.d.ts.map +0 -1
  218. package/declarations/types/cache/change.d.ts.map +0 -1
  219. package/declarations/types/cache/mutations.d.ts.map +0 -1
  220. package/declarations/types/cache/operations.d.ts.map +0 -1
  221. package/declarations/types/cache/relationship.d.ts.map +0 -1
  222. package/declarations/types/cache.d.ts.map +0 -1
  223. package/declarations/types/graph.d.ts.map +0 -1
  224. package/declarations/types/identifier.d.ts.map +0 -1
  225. package/declarations/types/json/raw.d.ts.map +0 -1
  226. package/declarations/types/params.d.ts.map +0 -1
  227. package/declarations/types/record.d.ts.map +0 -1
  228. package/declarations/types/record.type-test.d.ts +0 -2
  229. package/declarations/types/record.type-test.d.ts.map +0 -1
  230. package/declarations/types/request.d.ts.map +0 -1
  231. package/declarations/types/request.type-test.d.ts +0 -2
  232. package/declarations/types/request.type-test.d.ts.map +0 -1
  233. package/declarations/types/runtime.d.ts.map +0 -1
  234. package/declarations/types/schema/concepts.d.ts.map +0 -1
  235. package/declarations/types/schema/fields.d.ts.map +0 -1
  236. package/declarations/types/schema/fields.type-test.d.ts.map +0 -1
  237. package/declarations/types/spec/document.d.ts.map +0 -1
  238. package/declarations/types/spec/error.d.ts.map +0 -1
  239. package/declarations/types/spec/json-api-raw.d.ts.map +0 -1
  240. package/declarations/types/symbols.d.ts.map +0 -1
  241. package/declarations/types/utils.d.ts.map +0 -1
  242. package/declarations/types.d.ts.map +0 -1
  243. package/declarations/utils/string.d.ts.map +0 -1
  244. package/dist/build-config/babel-macros.js.map +0 -1
  245. package/dist/build-config/canary-features.js.map +0 -1
  246. package/dist/build-config/debugging.js.map +0 -1
  247. package/dist/build-config/deprecations.js.map +0 -1
  248. package/dist/build-config/env.js.map +0 -1
  249. package/dist/build-config/macros.js.map +0 -1
  250. package/dist/build-config.js.map +0 -1
  251. package/dist/configure-BgaZESRo.js.map +0 -1
  252. package/dist/configure.js.map +0 -1
  253. package/dist/context-COmAnXUQ.js.map +0 -1
  254. package/dist/graph/-private.js.map +0 -1
  255. package/dist/handler-cHghx9Y9.js.map +0 -1
  256. package/dist/index.js.map +0 -1
  257. package/dist/reactive/-private.js.map +0 -1
  258. package/dist/reactive.js.map +0 -1
  259. package/dist/request-state-DgwTEXLU.js.map +0 -1
  260. package/dist/request.js.map +0 -1
  261. package/dist/store/-private.js.map +0 -1
  262. package/dist/store.js.map +0 -1
  263. package/dist/symbols-BmDcn6hS.js.map +0 -1
  264. package/dist/types/-private.js.map +0 -1
  265. package/dist/types/cache/aliases.js.map +0 -1
  266. package/dist/types/cache/change.js.map +0 -1
  267. package/dist/types/cache/mutations.js.map +0 -1
  268. package/dist/types/cache/operations.js.map +0 -1
  269. package/dist/types/cache/relationship.js.map +0 -1
  270. package/dist/types/cache.js.map +0 -1
  271. package/dist/types/graph.js.map +0 -1
  272. package/dist/types/identifier.js.map +0 -1
  273. package/dist/types/json/raw.js.map +0 -1
  274. package/dist/types/params.js.map +0 -1
  275. package/dist/types/record.js.map +0 -1
  276. package/dist/types/request.js.map +0 -1
  277. package/dist/types/runtime.js.map +0 -1
  278. package/dist/types/schema/concepts.js.map +0 -1
  279. package/dist/types/schema/fields.js.map +0 -1
  280. package/dist/types/schema/fields.type-test.js.map +0 -1
  281. package/dist/types/spec/document.js.map +0 -1
  282. package/dist/types/spec/error.js.map +0 -1
  283. package/dist/types/spec/json-api-raw.js.map +0 -1
  284. package/dist/types/symbols.js.map +0 -1
  285. package/dist/types/utils.js.map +0 -1
  286. package/dist/types.js.map +0 -1
  287. package/dist/utils/string.js.map +0 -1
@@ -1,147 +1,146 @@
1
- import type { Store } from '../../store/-private/store-service.ts';
2
- import type { StableDocumentIdentifier } from '../../types/identifier.ts';
3
- import type { ImmutableRequestInfo, RequestInfo } from '../../types/request.ts';
4
- import type { ResourceDocument } from '../../types/spec/document.ts';
5
- import type { Meta, PaginationLinks } from '../../types/spec/json-api-raw.ts';
1
+ import type { Store } from "../../store/-private/store-service.js";
2
+ import type { StableDocumentIdentifier } from "../../types/identifier.js";
3
+ import type { ImmutableRequestInfo, RequestInfo } from "../../types/request.js";
4
+ import type { ResourceDocument } from "../../types/spec/document.js";
5
+ import type { Meta, PaginationLinks } from "../../types/spec/json-api-raw.js";
6
6
  /**
7
- * A Document is a class that wraps the response content from a request to the API
8
- * returned by `Cache.put` or `Cache.peek`, converting resource-identifiers into
9
- * record instances.
10
- *
11
- * It is not directly instantiated by the user, and its properties should not
12
- * be directly modified. Whether individual properties are mutable or not is
13
- * determined by the record instance itself.
14
- *
15
- * @public
16
- * @hideconstructor
17
- */
7
+ * A Document is a class that wraps the response content from a request to the API
8
+ * returned by `Cache.put` or `Cache.peek`, converting resource-identifiers into
9
+ * record instances.
10
+ *
11
+ * It is not directly instantiated by the user, and its properties should not
12
+ * be directly modified. Whether individual properties are mutable or not is
13
+ * determined by the record instance itself.
14
+ *
15
+ * @public
16
+ * @hideconstructor
17
+ */
18
18
  export declare class ReactiveDocument<T> {
19
- #private;
20
- /**
21
- * The links object for this document, if any
22
- *
23
- * e.g.
24
- *
25
- * ```
26
- * {
27
- * self: '/articles?page[number]=3',
28
- * }
29
- * ```
30
- *
31
- * @property links
32
- * @type {Object|undefined} - a links object
33
- * @public
34
- */
35
- readonly links?: PaginationLinks;
36
- /**
37
- * The primary data for this document, if any.
38
- *
39
- * If this document has no primary data (e.g. because it is an error document)
40
- * this property will be `undefined`.
41
- *
42
- * For collections this will be an array of record instances,
43
- * for single resource requests it will be a single record instance or null.
44
- *
45
- * @property data
46
- * @public
47
- * @type {Object|Array<object>|null|undefined} - a data object
48
- */
49
- readonly data?: T;
50
- /**
51
- * The errors returned by the API for this request, if any
52
- *
53
- * @property errors
54
- * @public
55
- * @type {Object|undefined} - an errors object
56
- */
57
- readonly errors?: object[];
58
- /**
59
- * The meta object for this document, if any
60
- *
61
- * @property meta
62
- * @public
63
- * @type {Object|undefined} - a meta object
64
- */
65
- readonly meta?: Meta;
66
- /**
67
- * The identifier associated with this document, if any
68
- *
69
- * @property identifier
70
- * @public
71
- * @type {StableDocumentIdentifier|null}
72
- */
73
- readonly identifier: StableDocumentIdentifier | null;
74
- protected readonly _store: Store;
75
- protected readonly _localCache: {
76
- document: ResourceDocument;
77
- request: ImmutableRequestInfo;
78
- } | null;
79
- constructor(store: Store, identifier: StableDocumentIdentifier | null, localCache: {
80
- document: ResourceDocument;
81
- request: ImmutableRequestInfo;
82
- } | null);
83
- /**
84
- * Fetches the related link for this document, returning a promise that resolves
85
- * with the document when the request completes. If no related link is present,
86
- * will fallback to the self link if present
87
- *
88
- * @public
89
- * @param {Object} options
90
- * @return {Promise<Document>}
91
- */
92
- fetch(options?: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T>>;
93
- /**
94
- * Fetches the next link for this document, returning a promise that resolves
95
- * with the new document when the request completes, or null if there is no
96
- * next link.
97
- *
98
- * @public
99
- * @param {Object} options
100
- * @return {Promise<Document | null>}
101
- */
102
- next(options?: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
103
- /**
104
- * Fetches the prev link for this document, returning a promise that resolves
105
- * with the new document when the request completes, or null if there is no
106
- * prev link.
107
- *
108
- * @public
109
- * @param {Object} options
110
- * @return {Promise<Document | null>}
111
- */
112
- prev(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
113
- /**
114
- * Fetches the first link for this document, returning a promise that resolves
115
- * with the new document when the request completes, or null if there is no
116
- * first link.
117
- *
118
- * @public
119
- * @param {Object} options
120
- * @return {Promise<Document | null>}
121
- */
122
- first(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
123
- /**
124
- * Fetches the last link for this document, returning a promise that resolves
125
- * with the new document when the request completes, or null if there is no
126
- * last link.
127
- *
128
- * @public
129
- * @param {Object} options
130
- * @return {Promise<Document | null>}
131
- */
132
- last(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
133
- /**
134
- * Implemented for `JSON.stringify` support.
135
- *
136
- * Returns the JSON representation of the document wrapper.
137
- *
138
- * This is a shallow serialization, it does not deeply serialize
139
- * the document's contents, leaving that to the individual record
140
- * instances to determine how to do, if at all.
141
- *
142
- * @public
143
- * @return
144
- */
145
- toJSON(): object;
19
+ #private;
20
+ /**
21
+ * The links object for this document, if any
22
+ *
23
+ * e.g.
24
+ *
25
+ * ```
26
+ * {
27
+ * self: '/articles?page[number]=3',
28
+ * }
29
+ * ```
30
+ *
31
+ * @property links
32
+ * @type {Object|undefined} - a links object
33
+ * @public
34
+ */
35
+ readonly links?: PaginationLinks;
36
+ /**
37
+ * The primary data for this document, if any.
38
+ *
39
+ * If this document has no primary data (e.g. because it is an error document)
40
+ * this property will be `undefined`.
41
+ *
42
+ * For collections this will be an array of record instances,
43
+ * for single resource requests it will be a single record instance or null.
44
+ *
45
+ * @property data
46
+ * @public
47
+ * @type {Object|Array<object>|null|undefined} - a data object
48
+ */
49
+ readonly data?: T;
50
+ /**
51
+ * The errors returned by the API for this request, if any
52
+ *
53
+ * @property errors
54
+ * @public
55
+ * @type {Object|undefined} - an errors object
56
+ */
57
+ readonly errors?: object[];
58
+ /**
59
+ * The meta object for this document, if any
60
+ *
61
+ * @property meta
62
+ * @public
63
+ * @type {Object|undefined} - a meta object
64
+ */
65
+ readonly meta?: Meta;
66
+ /**
67
+ * The identifier associated with this document, if any
68
+ *
69
+ * @property identifier
70
+ * @public
71
+ * @type {StableDocumentIdentifier|null}
72
+ */
73
+ readonly identifier: StableDocumentIdentifier | null;
74
+ protected readonly _store: Store;
75
+ protected readonly _localCache: {
76
+ document: ResourceDocument;
77
+ request: ImmutableRequestInfo;
78
+ } | null;
79
+ constructor(store: Store, identifier: StableDocumentIdentifier | null, localCache: {
80
+ document: ResourceDocument;
81
+ request: ImmutableRequestInfo;
82
+ } | null);
83
+ /**
84
+ * Fetches the related link for this document, returning a promise that resolves
85
+ * with the document when the request completes. If no related link is present,
86
+ * will fallback to the self link if present
87
+ *
88
+ * @public
89
+ * @param {Object} options
90
+ * @return {Promise<Document>}
91
+ */
92
+ fetch(options?: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T>>;
93
+ /**
94
+ * Fetches the next link for this document, returning a promise that resolves
95
+ * with the new document when the request completes, or null if there is no
96
+ * next link.
97
+ *
98
+ * @public
99
+ * @param {Object} options
100
+ * @return {Promise<Document | null>}
101
+ */
102
+ next(options?: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
103
+ /**
104
+ * Fetches the prev link for this document, returning a promise that resolves
105
+ * with the new document when the request completes, or null if there is no
106
+ * prev link.
107
+ *
108
+ * @public
109
+ * @param {Object} options
110
+ * @return {Promise<Document | null>}
111
+ */
112
+ prev(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
113
+ /**
114
+ * Fetches the first link for this document, returning a promise that resolves
115
+ * with the new document when the request completes, or null if there is no
116
+ * first link.
117
+ *
118
+ * @public
119
+ * @param {Object} options
120
+ * @return {Promise<Document | null>}
121
+ */
122
+ first(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
123
+ /**
124
+ * Fetches the last link for this document, returning a promise that resolves
125
+ * with the new document when the request completes, or null if there is no
126
+ * last link.
127
+ *
128
+ * @public
129
+ * @param {Object} options
130
+ * @return {Promise<Document | null>}
131
+ */
132
+ last(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
133
+ /**
134
+ * Implemented for `JSON.stringify` support.
135
+ *
136
+ * Returns the JSON representation of the document wrapper.
137
+ *
138
+ * This is a shallow serialization, it does not deeply serialize
139
+ * the document's contents, leaving that to the individual record
140
+ * instances to determine how to do, if at all.
141
+ *
142
+ * @public
143
+ * @return
144
+ */
145
+ toJSON(): object;
146
146
  }
147
- //# sourceMappingURL=document.d.ts.map
@@ -1,40 +1,43 @@
1
- import type { Store, StoreRequestInput } from '../../../index.ts';
2
- import type { Future } from '../../../request.ts';
3
- import { RelatedCollection as ManyArray } from '../../../store/-private.ts';
4
- import type { Cache } from '../../../types/cache.ts';
5
- import type { StableRecordIdentifier } from '../../../types/identifier.ts';
6
- import type { ArrayField, DerivedField, FieldSchema, GenericField, LegacyHasManyField, LocalField, ObjectField, SchemaArrayField, SchemaObjectField } from '../../../types/schema/fields.ts';
7
- import type { Links } from '../../../types/spec/json-api-raw.ts';
8
- import { RecordStore } from '../../../types/symbols.ts';
9
- import { ReactiveResource } from '../record.ts';
10
- import type { SchemaService } from '../schema.ts';
11
- import { Parent } from '../symbols.ts';
12
- import { ManagedArray } from './managed-array.ts';
13
- import { ManagedObject } from './managed-object.ts';
14
- export declare const ManagedArrayMap: Map<ReactiveResource, Map<string, ManagedArray | ManyArray<unknown>>>;
15
- export declare const ManagedObjectMap: Map<ReactiveResource, Map<string, ReactiveResource | ManagedObject>>;
1
+ import type { Store, StoreRequestInput } from "../../../index.js";
2
+ import type { Future } from "../../../request.js";
3
+ import { RelatedCollection as ManyArray } from "../../../store/-private.js";
4
+ import type { Cache } from "../../../types/cache.js";
5
+ import type { StableRecordIdentifier } from "../../../types/identifier.js";
6
+ import type { ArrayField, DerivedField, FieldSchema, GenericField, LegacyHasManyField, LocalField, ObjectField, SchemaArrayField, SchemaObjectField } from "../../../types/schema/fields.js";
7
+ import type { Links } from "../../../types/spec/json-api-raw.js";
8
+ import { RecordStore } from "../../../types/symbols.js";
9
+ import { ReactiveResource } from "../record.js";
10
+ import type { SchemaService } from "../schema.js";
11
+ import { Parent } from "../symbols.js";
12
+ import { ManagedArray } from "./managed-array.js";
13
+ import { ManagedObject } from "./managed-object.js";
14
+ export declare const ManagedArrayMap: Map<ReactiveResource, Map<string, ManagedArray | ManyArray>>;
15
+ export declare const ManagedObjectMap: Map<ReactiveResource, Map<string, ManagedObject | ReactiveResource>>;
16
16
  export declare function computeLocal(record: typeof Proxy<ReactiveResource>, field: LocalField, prop: string): unknown;
17
17
  export declare function peekManagedArray(record: ReactiveResource, field: FieldSchema): ManyArray | ManagedArray | undefined;
18
18
  export declare function peekManagedObject(record: ReactiveResource, field: ObjectField): ManagedObject | undefined;
19
19
  export declare function peekManagedObject(record: ReactiveResource, field: SchemaObjectField): ReactiveResource | undefined;
20
20
  export declare function computeField(schema: SchemaService, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: GenericField, prop: string | string[], editable: boolean): unknown;
21
21
  export declare function computeArray(store: Store, schema: SchemaService, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: ArrayField | SchemaArrayField, path: string[], editable: boolean, legacy: boolean): ManagedArray | null;
22
- export declare function computeObject(schema: SchemaService, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: ObjectField, path: string[], editable: boolean, legacy: boolean): ReactiveResource | ManagedObject | null;
23
- export declare function computeSchemaObject(store: Store, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: SchemaObjectField, path: string[], legacy: boolean, editable: boolean): ReactiveResource | ManagedObject | null;
22
+ export declare function computeObject(schema: SchemaService, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: ObjectField, path: string[], editable: boolean, legacy: boolean): ManagedObject | null;
23
+ export declare function computeSchemaObject(store: Store, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: SchemaObjectField, path: string[], legacy: boolean, editable: boolean): ReactiveResource | null;
24
24
  export declare function computeAttribute(cache: Cache, identifier: StableRecordIdentifier, prop: string, editable: boolean): unknown;
25
25
  export declare function computeDerivation(schema: SchemaService, record: ReactiveResource, identifier: StableRecordIdentifier, field: DerivedField, prop: string): unknown;
26
+ interface ResourceRelationship<T extends ReactiveResource = ReactiveResource> {
27
+ lid: string;
28
+ [Parent]: ReactiveResource;
29
+ [RecordStore]: Store;
30
+ name: string;
31
+ data: T | null;
32
+ links: Links;
33
+ meta: Record<string, unknown>;
34
+ }
35
+ // TODO probably this should just be a Document
36
+ // but its separate until we work out the lid situation
26
37
  declare class ResourceRelationship<T extends ReactiveResource = ReactiveResource> {
27
- lid: string;
28
- [Parent]: ReactiveResource;
29
- [RecordStore]: Store;
30
- name: string;
31
- data: T | null;
32
- links: Links;
33
- meta: Record<string, unknown>;
34
- constructor(store: Store, cache: Cache, parent: ReactiveResource, identifier: StableRecordIdentifier, field: FieldSchema, name: string, editable: boolean);
35
- fetch(options?: StoreRequestInput<T, T>): Future<T>;
38
+ constructor(store: Store, cache: Cache, parent: ReactiveResource, identifier: StableRecordIdentifier, field: FieldSchema, name: string, editable: boolean);
39
+ fetch(options?: StoreRequestInput<T, T>): Future<T>;
36
40
  }
37
41
  export declare function computeResource<T extends ReactiveResource>(store: Store, cache: Cache, parent: ReactiveResource, identifier: StableRecordIdentifier, field: FieldSchema, prop: string, editable: boolean): ResourceRelationship<T>;
38
- export declare function computeHasMany(store: Store, schema: SchemaService, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: LegacyHasManyField, path: string[], editable: boolean, legacy: boolean): ManyArray<unknown> | null;
42
+ export declare function computeHasMany(store: Store, schema: SchemaService, cache: Cache, record: ReactiveResource, identifier: StableRecordIdentifier, field: LegacyHasManyField, path: string[], editable: boolean, legacy: boolean): ManyArray | null;
39
43
  export {};
40
- //# sourceMappingURL=compute.d.ts.map
@@ -0,0 +1,8 @@
1
+ import type { SignalStore, WarpDriveSignal } from "../../../store/-private/new-core-tmp/reactivity/internal.js";
2
+ import type { ExtensionDef } from "../schema.js";
3
+ export type ProxiedMethod = (...args: unknown[]) => unknown;
4
+ export declare function expectNever(value: never): void;
5
+ export declare function isExtensionProp(extensions: Map<string | symbol, ExtensionDef> | null, prop: string | number | symbol): prop is string | symbol;
6
+ export declare function performObjectExtensionGet(receiver: object, extensions: Map<string | symbol, ExtensionDef>, signals: SignalStore, prop: string | symbol): unknown;
7
+ export declare function performExtensionSet(receiver: object, extensions: Map<string | symbol, ExtensionDef>, signals: SignalStore, prop: string | symbol, value: unknown): boolean;
8
+ export declare function performArrayExtensionGet(receiver: object, extensions: Map<string | symbol, ExtensionDef>, signals: SignalStore, prop: string | symbol, _SIGNAL: WarpDriveSignal, boundFns: Map<string | symbol | number, ProxiedMethod>, transaction: (v: boolean) => void): unknown;
@@ -1,23 +1,22 @@
1
- import type { Store } from '../../../index.ts';
2
- import type { WarpDriveSignal } from '../../../store/-private.ts';
3
- import { ARRAY_SIGNAL } from '../../../store/-private.ts';
4
- import type { Cache } from '../../../types/cache.ts';
5
- import type { StableRecordIdentifier } from '../../../types/identifier.ts';
6
- import type { ArrayField, SchemaArrayField } from '../../../types/schema/fields.ts';
7
- import { ReactiveResource } from '../record.ts';
8
- import type { SchemaService } from '../schema.ts';
9
- import { Editable, Legacy, MUTATE, SOURCE } from '../symbols.ts';
10
- export interface ManagedArray extends Omit<Array<unknown>, '[]'> {
11
- [MUTATE]?(target: unknown[], receiver: typeof Proxy<unknown[]>, prop: string, args: unknown[], _SIGNAL: WarpDriveSignal): unknown;
1
+ import type { Store } from "../../../index.js";
2
+ import type { WarpDriveSignal } from "../../../store/-private.js";
3
+ import { ARRAY_SIGNAL } from "../../../store/-private.js";
4
+ import type { Cache } from "../../../types/cache.js";
5
+ import type { StableRecordIdentifier } from "../../../types/identifier.js";
6
+ import type { ArrayField, SchemaArrayField } from "../../../types/schema/fields.js";
7
+ import { ReactiveResource } from "../record.js";
8
+ import type { SchemaService } from "../schema.js";
9
+ import { Editable, Legacy, SOURCE } from "../symbols.js";
10
+ export interface ManagedArray extends Omit<Array<unknown>, "[]"> {
11
+ [SOURCE]: unknown[];
12
+ identifier: StableRecordIdentifier;
13
+ path: string[];
14
+ owner: ReactiveResource;
15
+ [ARRAY_SIGNAL]: WarpDriveSignal;
16
+ [Editable]: boolean;
17
+ [Legacy]: boolean;
12
18
  }
19
+ // eslint-disable-next-line @typescript-eslint/no-extraneous-class
13
20
  export declare class ManagedArray {
14
- [SOURCE]: unknown[];
15
- identifier: StableRecordIdentifier;
16
- path: string[];
17
- owner: ReactiveResource;
18
- [ARRAY_SIGNAL]: WarpDriveSignal;
19
- [Editable]: boolean;
20
- [Legacy]: boolean;
21
- constructor(store: Store, schema: SchemaService, cache: Cache, field: ArrayField | SchemaArrayField, data: unknown[], identifier: StableRecordIdentifier, path: string[], owner: ReactiveResource, isSchemaArray: boolean, editable: boolean, legacy: boolean);
21
+ constructor(store: Store, schema: SchemaService, cache: Cache, field: ArrayField | SchemaArrayField, data: unknown[], identifier: StableRecordIdentifier, path: string[], owner: ReactiveResource, isSchemaArray: boolean, editable: boolean, legacy: boolean);
22
22
  }
23
- //# sourceMappingURL=managed-array.d.ts.map
@@ -1,21 +1,21 @@
1
- import { OBJECT_SIGNAL, type WarpDriveSignal } from '../../../store/-private.ts';
2
- import type { Cache } from '../../../types/cache.ts';
3
- import type { StableRecordIdentifier } from '../../../types/identifier.ts';
4
- import type { ObjectField, SchemaObjectField } from '../../../types/schema/fields.ts';
5
- import type { ReactiveResource } from '../record.ts';
6
- import type { SchemaService } from '../schema.ts';
7
- import { Editable, EmbeddedPath, Legacy, MUTATE, Parent, SOURCE } from '../symbols.ts';
1
+ import { OBJECT_SIGNAL, type WarpDriveSignal } from "../../../store/-private.js";
2
+ import type { Cache } from "../../../types/cache.js";
3
+ import type { StableRecordIdentifier } from "../../../types/identifier.js";
4
+ import type { ObjectField, SchemaObjectField } from "../../../types/schema/fields.js";
5
+ import type { ReactiveResource } from "../record.js";
6
+ import type { SchemaService } from "../schema.js";
7
+ import { Editable, EmbeddedPath, Legacy, Parent, SOURCE } from "../symbols.js";
8
8
  export declare function notifyObject(obj: ManagedObject): void;
9
+ // const ignoredGlobalFields = new Set<string>(['setInterval', 'nodeType', 'nodeName', 'length', 'document', STRUCTURED]);
9
10
  export interface ManagedObject {
10
- [MUTATE]?(target: unknown[], receiver: typeof Proxy<unknown[]>, prop: string, args: unknown[], _SIGNAL: WarpDriveSignal): unknown;
11
+ [SOURCE]: object;
12
+ [Parent]: StableRecordIdentifier;
13
+ [EmbeddedPath]: string[];
14
+ [OBJECT_SIGNAL]: WarpDriveSignal;
15
+ [Editable]: boolean;
16
+ [Legacy]: boolean;
11
17
  }
18
+ // eslint-disable-next-line @typescript-eslint/no-extraneous-class
12
19
  export declare class ManagedObject {
13
- [SOURCE]: object;
14
- [Parent]: StableRecordIdentifier;
15
- [EmbeddedPath]: string[];
16
- [OBJECT_SIGNAL]: WarpDriveSignal;
17
- [Editable]: boolean;
18
- [Legacy]: boolean;
19
- constructor(schema: SchemaService, cache: Cache, field: ObjectField | SchemaObjectField, data: object, identifier: StableRecordIdentifier, path: string[], owner: ReactiveResource, editable: boolean, legacy: boolean);
20
+ constructor(schema: SchemaService, cache: Cache, field: ObjectField | SchemaObjectField, data: object, identifier: StableRecordIdentifier, path: string[], owner: ReactiveResource, editable: boolean, legacy: boolean);
20
21
  }
21
- //# sourceMappingURL=managed-object.d.ts.map
@@ -1,20 +1,19 @@
1
- import type { Store } from '../../../index.ts';
2
- import type { RelatedCollection as ManyArray } from '../../../store/-private.ts';
3
- import type { LocalRelationshipOperation } from '../../../types/graph.ts';
4
- import type { StableRecordIdentifier } from '../../../types/identifier.ts';
5
- import type { ReactiveResource } from '../record.ts';
1
+ import type { Store } from "../../../index.js";
2
+ import type { RelatedCollection as ManyArray } from "../../../store/-private.js";
3
+ import type { LocalRelationshipOperation } from "../../../types/graph.js";
4
+ import type { StableRecordIdentifier } from "../../../types/identifier.js";
5
+ import type { ReactiveResource } from "../record.js";
6
6
  export interface FindHasManyOptions {
7
- reload?: boolean;
8
- backgroundReload?: boolean;
7
+ reload?: boolean;
8
+ backgroundReload?: boolean;
9
9
  }
10
10
  export declare class ManyArrayManager {
11
- record: ReactiveResource;
12
- store: Store;
13
- identifier: StableRecordIdentifier;
14
- editable: boolean;
15
- constructor(record: ReactiveResource, editable: boolean);
16
- _syncArray(array: ManyArray): void;
17
- reloadHasMany<T>(key: string, options?: FindHasManyOptions): Promise<ManyArray<T>>;
18
- mutate(mutation: LocalRelationshipOperation): void;
11
+ record: ReactiveResource;
12
+ store: Store;
13
+ identifier: StableRecordIdentifier;
14
+ editable: boolean;
15
+ constructor(record: ReactiveResource, editable: boolean);
16
+ _syncArray(array: ManyArray): void;
17
+ reloadHasMany<T>(key: string, options?: FindHasManyOptions): Promise<ManyArray<T>>;
18
+ mutate(mutation: LocalRelationshipOperation): void;
19
19
  }
20
- //# sourceMappingURL=many-array-manager.d.ts.map
@@ -1,6 +1,5 @@
1
- import type { Store } from '../../index.ts';
2
- import type { StableRecordIdentifier } from '../../types.ts';
3
- import { ReactiveResource } from './record.ts';
1
+ import type { Store } from "../../index.js";
2
+ import type { StableRecordIdentifier } from "../../types.js";
3
+ import { ReactiveResource } from "./record.js";
4
4
  export declare function instantiateRecord(store: Store, identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): ReactiveResource;
5
5
  export declare function teardownRecord(record: unknown): void;
6
- //# sourceMappingURL=hooks.d.ts.map
@@ -1,61 +1,64 @@
1
- import type { Store } from '../../index.ts';
2
- import type { StableRecordIdentifier } from '../../types/identifier.ts';
3
- import { RecordStore } from '../../types/symbols.ts';
4
- import { Checkout, Destroy, Editable, EmbeddedPath, EmbeddedType, Identifier, Legacy, Parent } from './symbols.ts';
5
- export { Editable, Legacy, Checkout } from './symbols';
1
+ import type { Store } from "../../index.js";
2
+ import type { StableRecordIdentifier } from "../../types/identifier.js";
3
+ import type { SchemaArrayField, SchemaObjectField } from "../../types/schema/fields.js";
4
+ import { RecordStore } from "../../types/symbols.js";
5
+ import { Checkout, Destroy, Editable, EmbeddedField, EmbeddedPath, Identifier, Legacy, Parent } from "./symbols.js";
6
+ export { Editable, Legacy, Checkout } from "./symbols.js";
7
+ export interface ReactiveResource {
8
+ [Symbol.toStringTag]: `ReactiveResource<${string}>`;
9
+ /** @internal */
10
+ [RecordStore]: Store;
11
+ /** @internal */
12
+ [Identifier]: StableRecordIdentifier;
13
+ /** @internal */
14
+ [Parent]: StableRecordIdentifier;
15
+ /** @internal */
16
+ [EmbeddedField]: SchemaArrayField | SchemaObjectField | null;
17
+ /** @internal */
18
+ [EmbeddedPath]: string[] | null;
19
+ /** @internal */
20
+ [Editable]: boolean;
21
+ /** @internal */
22
+ [Legacy]: boolean;
23
+ /** @internal */
24
+ ___notifications: object;
25
+ /** @internal */
26
+ [Destroy](): void;
27
+ /**
28
+ * Create an editable copy of the record
29
+ *
30
+ * ReactiveResource instances are not editable by default. This method creates an editable copy of the record. To use,
31
+ * import the `Checkout` symbol from `@warp-drive/schema-record` and call it on the record.
32
+ *
33
+ * ```ts
34
+ * import { Checkout } from '@warp-drive/schema-record';
35
+ *
36
+ * const record = store.peekRecord('user', '1');
37
+ * const editableRecord = await record[Checkout]();
38
+ * ```
39
+ *
40
+ * @returns a promise that resolves to the editable record
41
+ * @throws if the record is already editable or if the record is embedded
42
+ *
43
+ */
44
+ [Checkout]<T>(): Promise<T>;
45
+ }
6
46
  /**
7
- * A class that uses a the ResourceSchema for a ResourceType
8
- * and a ResouceKey to transform data from the cache into a rich, reactive
9
- * object.
10
- *
11
- * This class is not directly instantiable. To use it, you should
12
- * configure the store's `instantiateRecord` and `teardownRecord` hooks
13
- * with the matching hooks provided by this package.
14
- *
15
- * @hideconstructor
16
- * @public
17
- */
47
+ * A class that uses a the ResourceSchema for a ResourceType
48
+ * and a ResouceKey to transform data from the cache into a rich, reactive
49
+ * object.
50
+ *
51
+ * This class is not directly instantiable. To use it, you should
52
+ * configure the store's `instantiateRecord` and `teardownRecord` hooks
53
+ * with the matching hooks provided by this package.
54
+ *
55
+ * @hideconstructor
56
+ * @public
57
+ */
58
+ // eslint-disable-next-line @typescript-eslint/no-extraneous-class
18
59
  export declare class ReactiveResource {
19
- /** @internal */
20
- [RecordStore]: Store;
21
- /** @internal */
22
- [Identifier]: StableRecordIdentifier;
23
- /** @internal */
24
- [Parent]: StableRecordIdentifier;
25
- /** @internal */
26
- [EmbeddedType]: string | null;
27
- /** @internal */
28
- [EmbeddedPath]: string[] | null;
29
- /** @internal */
30
- [Editable]: boolean;
31
- /** @internal */
32
- [Legacy]: boolean;
33
- [Symbol.toStringTag]: `ReactiveResource<${string}>`;
34
- /** @internal */
35
- ___notifications: object;
36
- constructor(store: Store, identifier: StableRecordIdentifier, Mode: {
37
- [Editable]: boolean;
38
- [Legacy]: boolean;
39
- }, isEmbedded?: boolean, embeddedType?: string | null, embeddedPath?: string[] | null);
40
- /** @internal */
41
- [Destroy](): void;
42
- /**
43
- * Create an editable copy of the record
44
- *
45
- * ReactiveResource instances are not editable by default. This method creates an editable copy of the record. To use,
46
- * import the `Checkout` symbol from `@warp-drive/schema-record` and call it on the record.
47
- *
48
- * ```ts
49
- * import { Checkout } from '@warp-drive/schema-record';
50
- *
51
- * const record = store.peekRecord('user', '1');
52
- * const editableRecord = await record[Checkout]();
53
- * ```
54
- *
55
- * @returns a promise that resolves to the editable record
56
- * @throws if the record is already editable or if the record is embedded
57
- *
58
- */
59
- [Checkout](): Promise<ReactiveResource>;
60
+ constructor(store: Store, identifier: StableRecordIdentifier, Mode: {
61
+ [Editable]: boolean;
62
+ [Legacy]: boolean;
63
+ }, isEmbedded?: boolean, embeddedField?: SchemaArrayField | SchemaObjectField | null, embeddedPath?: string[] | null);
60
64
  }
61
- //# sourceMappingURL=record.d.ts.map