@osdk/client 2.2.0-beta.2 → 2.2.0-beta.21

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 (483) hide show
  1. package/CHANGELOG.md +282 -0
  2. package/build/browser/Client.js.map +1 -1
  3. package/build/browser/MinimalClientContext.js.map +1 -1
  4. package/build/browser/__unstable/ConjureSupport.js.map +1 -1
  5. package/build/browser/actions/ActionValidationError.js +1 -1
  6. package/build/browser/actions/ActionValidationError.js.map +1 -1
  7. package/build/browser/actions/actions.test.js +226 -87
  8. package/build/browser/actions/actions.test.js.map +1 -1
  9. package/build/browser/actions/applyAction.js +28 -16
  10. package/build/browser/actions/applyAction.js.map +1 -1
  11. package/build/browser/createClient.js +19 -8
  12. package/build/browser/createClient.js.map +1 -1
  13. package/build/browser/createClient.test.js +14 -6
  14. package/build/browser/createClient.test.js.map +1 -1
  15. package/build/browser/createMinimalClient.js +2 -2
  16. package/build/browser/createMinimalClient.js.map +1 -1
  17. package/build/browser/createMinimalClientHelper.js +25 -0
  18. package/build/browser/createMinimalClientHelper.js.map +1 -0
  19. package/build/browser/derivedProperties/createWithPropertiesObjectSet.js +36 -13
  20. package/build/browser/derivedProperties/createWithPropertiesObjectSet.js.map +1 -1
  21. package/build/browser/derivedProperties/createWithPropertiesObjectSet.test.js +133 -0
  22. package/build/browser/derivedProperties/createWithPropertiesObjectSet.test.js.map +1 -1
  23. package/build/browser/derivedProperties/derivedPropertyDefinitionFactory.js +94 -0
  24. package/build/browser/derivedProperties/derivedPropertyDefinitionFactory.js.map +1 -0
  25. package/build/browser/fetchMetadata.test.js +11 -9
  26. package/build/browser/fetchMetadata.test.js.map +1 -1
  27. package/build/browser/index.js +1 -0
  28. package/build/browser/index.js.map +1 -1
  29. package/build/browser/intellisense.test.helpers/showsObjectPropertyJsdoc.js +25 -0
  30. package/build/browser/intellisense.test.helpers/showsObjectPropertyJsdoc.js.map +1 -0
  31. package/build/browser/intellisense.test.js +17 -1
  32. package/build/browser/intellisense.test.js.map +1 -1
  33. package/build/browser/internal/conversions/modernToLegacyGroupByClause.js +7 -0
  34. package/build/browser/internal/conversions/modernToLegacyGroupByClause.js.map +1 -1
  35. package/build/browser/internal/conversions/modernToLegacyWhereClause.js +1 -1
  36. package/build/browser/internal/conversions/modernToLegacyWhereClause.js.map +1 -1
  37. package/build/browser/logger/BaseLogger.js +59 -0
  38. package/build/browser/logger/BaseLogger.js.map +1 -0
  39. package/build/browser/logger/BrowserLogger.js +67 -0
  40. package/build/browser/logger/BrowserLogger.js.map +1 -0
  41. package/build/browser/logger/MinimalLogger.js +39 -0
  42. package/build/browser/logger/MinimalLogger.js.map +1 -0
  43. package/build/browser/logger/MinimalLogger.test.js +60 -0
  44. package/build/browser/logger/MinimalLogger.test.js.map +1 -0
  45. package/build/browser/logger/TestLogger.js +56 -0
  46. package/build/browser/logger/TestLogger.js.map +1 -0
  47. package/build/browser/object/AttachmentUpload.js +3 -0
  48. package/build/browser/object/AttachmentUpload.js.map +1 -1
  49. package/build/browser/object/SimpleOsdkProperties.js +2 -0
  50. package/build/browser/object/SimpleOsdkProperties.js.map +1 -0
  51. package/build/browser/object/aggregate.test.js +12 -2
  52. package/build/browser/object/aggregate.test.js.map +1 -1
  53. package/build/browser/object/attachment.test.js +20 -7
  54. package/build/browser/object/attachment.test.js.map +1 -1
  55. package/build/browser/object/convertWireToOsdkObjects/BaseHolder.js +2 -0
  56. package/build/browser/object/convertWireToOsdkObjects/BaseHolder.js.map +1 -0
  57. package/build/browser/object/convertWireToOsdkObjects/InterfaceHolder.js.map +1 -1
  58. package/build/browser/object/convertWireToOsdkObjects/ObjectHolder.js.map +1 -1
  59. package/build/browser/object/convertWireToOsdkObjects/createOsdkInterface.js +29 -0
  60. package/build/browser/object/convertWireToOsdkObjects/createOsdkInterface.js.map +1 -1
  61. package/build/browser/object/convertWireToOsdkObjects/createOsdkObject.js +53 -35
  62. package/build/browser/object/convertWireToOsdkObjects/createOsdkObject.js.map +1 -1
  63. package/build/browser/object/convertWireToOsdkObjects/getDollarAs.js.map +1 -1
  64. package/build/browser/object/convertWireToOsdkObjects/getDollarLink.js.map +1 -1
  65. package/build/browser/object/convertWireToOsdkObjects.js +10 -11
  66. package/build/browser/object/convertWireToOsdkObjects.js.map +1 -1
  67. package/build/browser/object/convertWireToOsdkObjects.test.js +46 -36
  68. package/build/browser/object/convertWireToOsdkObjects.test.js.map +1 -1
  69. package/build/browser/object/fetchPage.js +17 -4
  70. package/build/browser/object/fetchPage.js.map +1 -1
  71. package/build/browser/object/fetchPage.test.js +56 -2
  72. package/build/browser/object/fetchPage.test.js.map +1 -1
  73. package/build/browser/object/geotimeseriesreference.test.js +56 -134
  74. package/build/browser/object/geotimeseriesreference.test.js.map +1 -1
  75. package/build/browser/object/media.test.js +19 -14
  76. package/build/browser/object/media.test.js.map +1 -1
  77. package/build/browser/object/object.test.js +182 -66
  78. package/build/browser/object/object.test.js.map +1 -1
  79. package/build/browser/object/timeseries.test.js +119 -85
  80. package/build/browser/object/timeseries.test.js.map +1 -1
  81. package/build/browser/objectSet/InterfaceObjectSet.test.js +37 -17
  82. package/build/browser/objectSet/InterfaceObjectSet.test.js.map +1 -1
  83. package/build/browser/objectSet/ObjectSet.test.js +212 -114
  84. package/build/browser/objectSet/ObjectSet.test.js.map +1 -1
  85. package/build/browser/objectSet/ObjectSetListenerWebsocket.js +20 -16
  86. package/build/browser/objectSet/ObjectSetListenerWebsocket.js.map +1 -1
  87. package/build/browser/objectSet/ObjectSetListenerWebsocket.test.js +21 -12
  88. package/build/browser/objectSet/ObjectSetListenerWebsocket.test.js.map +1 -1
  89. package/build/browser/objectSet/createObjectSet.js +2 -1
  90. package/build/browser/objectSet/createObjectSet.js.map +1 -1
  91. package/build/browser/observable/ListPayload.js.map +1 -1
  92. package/build/browser/observable/ObjectPayload.js.map +1 -1
  93. package/build/browser/observable/ObservableClient.js.map +1 -1
  94. package/build/browser/observable/OptimisticBuilder.js.map +1 -1
  95. package/build/browser/observable/internal/ActionApplication.js +102 -0
  96. package/build/browser/observable/internal/ActionApplication.js.map +1 -0
  97. package/build/browser/observable/internal/BulkObjectLoader.js +93 -0
  98. package/build/browser/observable/internal/BulkObjectLoader.js.map +1 -0
  99. package/build/browser/observable/internal/BulkObjectLoader.test.js +112 -0
  100. package/build/browser/observable/internal/BulkObjectLoader.test.js.map +1 -0
  101. package/build/browser/observable/internal/CacheKey.js +38 -1
  102. package/build/browser/observable/internal/CacheKey.js.map +1 -1
  103. package/build/browser/observable/internal/CacheKeys.js +4 -4
  104. package/build/browser/observable/internal/CacheKeys.js.map +1 -1
  105. package/build/browser/observable/internal/Changes.js +58 -0
  106. package/build/browser/observable/internal/Changes.js.map +1 -0
  107. package/build/browser/observable/internal/Layer.js +6 -3
  108. package/build/browser/observable/internal/Layer.js.map +1 -1
  109. package/build/browser/observable/internal/ListQuery.js +495 -129
  110. package/build/browser/observable/internal/ListQuery.js.map +1 -1
  111. package/build/browser/observable/internal/ObjectQuery.js +40 -14
  112. package/build/browser/observable/internal/ObjectQuery.js.map +1 -1
  113. package/build/browser/observable/internal/ObservableClientImpl.js +4 -12
  114. package/build/browser/observable/internal/ObservableClientImpl.js.map +1 -1
  115. package/build/browser/observable/internal/OptimisticJob.js +30 -29
  116. package/build/browser/observable/internal/OptimisticJob.js.map +1 -1
  117. package/build/browser/observable/internal/OrderByCanonicalizer.js +73 -0
  118. package/build/browser/observable/internal/OrderByCanonicalizer.js.map +1 -0
  119. package/build/browser/observable/internal/OrderByCanonicalizer.test.js +78 -0
  120. package/build/browser/observable/internal/OrderByCanonicalizer.test.js.map +1 -0
  121. package/build/browser/observable/internal/Query.js +79 -6
  122. package/build/browser/observable/internal/Query.js.map +1 -1
  123. package/build/browser/observable/internal/RefCounts.js +7 -2
  124. package/build/browser/observable/internal/RefCounts.js.map +1 -1
  125. package/build/browser/observable/internal/SimpleWhereClause.js +2 -0
  126. package/build/browser/observable/internal/SimpleWhereClause.js.map +1 -0
  127. package/build/browser/observable/internal/Store.js +140 -190
  128. package/build/browser/observable/internal/Store.js.map +1 -1
  129. package/build/browser/observable/internal/Store.test.js +666 -300
  130. package/build/browser/observable/internal/Store.test.js.map +1 -1
  131. package/build/browser/observable/internal/WhereClauseCanonicalizer.js +11 -3
  132. package/build/browser/observable/internal/WhereClauseCanonicalizer.js.map +1 -1
  133. package/build/browser/observable/internal/objectMatchesWhereClause.js +0 -4
  134. package/build/browser/observable/internal/objectMatchesWhereClause.js.map +1 -1
  135. package/build/browser/observable/internal/objectMatchesWhereClause.test.js.map +1 -1
  136. package/build/browser/observable/internal/testUtils.js +222 -19
  137. package/build/browser/observable/internal/testUtils.js.map +1 -1
  138. package/build/browser/ontology/StandardOntologyProvider.test.js +17 -16
  139. package/build/browser/ontology/StandardOntologyProvider.test.js.map +1 -1
  140. package/build/browser/ontology/loadFullObjectMetadata.js +0 -1
  141. package/build/browser/ontology/loadFullObjectMetadata.js.map +1 -1
  142. package/build/browser/public/internal.js +2 -0
  143. package/build/browser/public/internal.js.map +1 -1
  144. package/build/browser/public/unstable-do-not-use.js +1 -0
  145. package/build/browser/public/unstable-do-not-use.js.map +1 -1
  146. package/build/browser/public-utils/osdkConfig.js +49 -0
  147. package/build/browser/public-utils/osdkConfig.js.map +1 -0
  148. package/build/{esm/observable/internal/ChangedObjects.js → browser/public-utils/vite-env.d.ts} +2 -7
  149. package/build/browser/queries/applyQuery.js +34 -2
  150. package/build/browser/queries/applyQuery.js.map +1 -1
  151. package/build/browser/queries/queries.test.js +36 -13
  152. package/build/browser/queries/queries.test.js.map +1 -1
  153. package/build/browser/queries/types.js.map +1 -1
  154. package/build/browser/tsserver.js.map +1 -1
  155. package/build/browser/util/UserAgent.js +1 -1
  156. package/build/browser/util/UserAgent.js.map +1 -1
  157. package/build/browser/util/extractRdpDefinition.js +140 -0
  158. package/build/browser/util/extractRdpDefinition.js.map +1 -0
  159. package/build/browser/util/extractRdpDefinition.test.js +233 -0
  160. package/build/browser/util/extractRdpDefinition.test.js.map +1 -0
  161. package/build/browser/{observable/internal/ChangedObjects.js → util/isPoint.js} +3 -7
  162. package/build/browser/util/isPoint.js.map +1 -0
  163. package/build/browser/util/objectSpecifierUtils.js +48 -0
  164. package/build/browser/util/objectSpecifierUtils.js.map +1 -0
  165. package/build/browser/util/objectSpecifierUtils.test.js +42 -0
  166. package/build/browser/util/objectSpecifierUtils.test.js.map +1 -0
  167. package/build/browser/util/toDataValue.js +14 -2
  168. package/build/browser/util/toDataValue.js.map +1 -1
  169. package/build/browser/util/toDataValue.test.js +37 -16
  170. package/build/browser/util/toDataValue.test.js.map +1 -1
  171. package/build/browser/util/toDataValueQueries.js +25 -2
  172. package/build/browser/util/toDataValueQueries.js.map +1 -1
  173. package/build/cjs/{Client-C8K3E1vH.d.cts → Client-CgL2LKN9.d.cts} +7 -8
  174. package/build/cjs/{chunk-T5UE6BI7.cjs → chunk-33GHS3X4.cjs} +256 -80
  175. package/build/cjs/chunk-33GHS3X4.cjs.map +1 -0
  176. package/build/cjs/{chunk-X7WGNFZ4.cjs → chunk-37QC7LR3.cjs} +173 -34
  177. package/build/cjs/chunk-37QC7LR3.cjs.map +1 -0
  178. package/build/cjs/chunk-T4NIFYZS.cjs +14 -0
  179. package/build/cjs/chunk-T4NIFYZS.cjs.map +1 -0
  180. package/build/cjs/index.cjs +298 -177
  181. package/build/cjs/index.cjs.map +1 -1
  182. package/build/cjs/index.d.cts +14 -22
  183. package/build/cjs/public/internal.cjs +61 -7
  184. package/build/cjs/public/internal.cjs.map +1 -1
  185. package/build/cjs/public/internal.d.cts +50 -3
  186. package/build/cjs/public/unstable-do-not-use.cjs +1181 -527
  187. package/build/cjs/public/unstable-do-not-use.cjs.map +1 -1
  188. package/build/cjs/public/unstable-do-not-use.d.cts +44 -25
  189. package/build/esm/Client.js.map +1 -1
  190. package/build/esm/MinimalClientContext.js.map +1 -1
  191. package/build/esm/__unstable/ConjureSupport.js.map +1 -1
  192. package/build/esm/actions/ActionValidationError.js +1 -1
  193. package/build/esm/actions/ActionValidationError.js.map +1 -1
  194. package/build/esm/actions/actions.test.js +226 -87
  195. package/build/esm/actions/actions.test.js.map +1 -1
  196. package/build/esm/actions/applyAction.js +28 -16
  197. package/build/esm/actions/applyAction.js.map +1 -1
  198. package/build/esm/createClient.js +19 -8
  199. package/build/esm/createClient.js.map +1 -1
  200. package/build/esm/createClient.test.js +14 -6
  201. package/build/esm/createClient.test.js.map +1 -1
  202. package/build/esm/createMinimalClient.js +2 -2
  203. package/build/esm/createMinimalClient.js.map +1 -1
  204. package/build/esm/createMinimalClientHelper.js +25 -0
  205. package/build/esm/createMinimalClientHelper.js.map +1 -0
  206. package/build/esm/derivedProperties/createWithPropertiesObjectSet.js +36 -13
  207. package/build/esm/derivedProperties/createWithPropertiesObjectSet.js.map +1 -1
  208. package/build/esm/derivedProperties/createWithPropertiesObjectSet.test.js +133 -0
  209. package/build/esm/derivedProperties/createWithPropertiesObjectSet.test.js.map +1 -1
  210. package/build/esm/derivedProperties/derivedPropertyDefinitionFactory.js +94 -0
  211. package/build/esm/derivedProperties/derivedPropertyDefinitionFactory.js.map +1 -0
  212. package/build/esm/fetchMetadata.test.js +11 -9
  213. package/build/esm/fetchMetadata.test.js.map +1 -1
  214. package/build/esm/index.js +1 -0
  215. package/build/esm/index.js.map +1 -1
  216. package/build/esm/intellisense.test.helpers/showsObjectPropertyJsdoc.js +25 -0
  217. package/build/esm/intellisense.test.helpers/showsObjectPropertyJsdoc.js.map +1 -0
  218. package/build/esm/intellisense.test.js +17 -1
  219. package/build/esm/intellisense.test.js.map +1 -1
  220. package/build/esm/internal/conversions/modernToLegacyGroupByClause.js +7 -0
  221. package/build/esm/internal/conversions/modernToLegacyGroupByClause.js.map +1 -1
  222. package/build/esm/internal/conversions/modernToLegacyWhereClause.js +1 -1
  223. package/build/esm/internal/conversions/modernToLegacyWhereClause.js.map +1 -1
  224. package/build/esm/logger/BaseLogger.js +59 -0
  225. package/build/esm/logger/BaseLogger.js.map +1 -0
  226. package/build/esm/logger/BrowserLogger.js +67 -0
  227. package/build/esm/logger/BrowserLogger.js.map +1 -0
  228. package/build/esm/logger/MinimalLogger.js +39 -0
  229. package/build/esm/logger/MinimalLogger.js.map +1 -0
  230. package/build/esm/logger/MinimalLogger.test.js +60 -0
  231. package/build/esm/logger/MinimalLogger.test.js.map +1 -0
  232. package/build/esm/logger/TestLogger.js +56 -0
  233. package/build/esm/logger/TestLogger.js.map +1 -0
  234. package/build/esm/object/AttachmentUpload.js +3 -0
  235. package/build/esm/object/AttachmentUpload.js.map +1 -1
  236. package/build/esm/object/SimpleOsdkProperties.js +2 -0
  237. package/build/esm/object/SimpleOsdkProperties.js.map +1 -0
  238. package/build/esm/object/aggregate.test.js +12 -2
  239. package/build/esm/object/aggregate.test.js.map +1 -1
  240. package/build/esm/object/attachment.test.js +20 -7
  241. package/build/esm/object/attachment.test.js.map +1 -1
  242. package/build/esm/object/convertWireToOsdkObjects/BaseHolder.js +2 -0
  243. package/build/esm/object/convertWireToOsdkObjects/BaseHolder.js.map +1 -0
  244. package/build/esm/object/convertWireToOsdkObjects/InterfaceHolder.js.map +1 -1
  245. package/build/esm/object/convertWireToOsdkObjects/ObjectHolder.js.map +1 -1
  246. package/build/esm/object/convertWireToOsdkObjects/createOsdkInterface.js +29 -0
  247. package/build/esm/object/convertWireToOsdkObjects/createOsdkInterface.js.map +1 -1
  248. package/build/esm/object/convertWireToOsdkObjects/createOsdkObject.js +53 -35
  249. package/build/esm/object/convertWireToOsdkObjects/createOsdkObject.js.map +1 -1
  250. package/build/esm/object/convertWireToOsdkObjects/getDollarAs.js.map +1 -1
  251. package/build/esm/object/convertWireToOsdkObjects/getDollarLink.js.map +1 -1
  252. package/build/esm/object/convertWireToOsdkObjects.js +10 -11
  253. package/build/esm/object/convertWireToOsdkObjects.js.map +1 -1
  254. package/build/esm/object/convertWireToOsdkObjects.test.js +46 -36
  255. package/build/esm/object/convertWireToOsdkObjects.test.js.map +1 -1
  256. package/build/esm/object/fetchPage.js +17 -4
  257. package/build/esm/object/fetchPage.js.map +1 -1
  258. package/build/esm/object/fetchPage.test.js +56 -2
  259. package/build/esm/object/fetchPage.test.js.map +1 -1
  260. package/build/esm/object/geotimeseriesreference.test.js +56 -134
  261. package/build/esm/object/geotimeseriesreference.test.js.map +1 -1
  262. package/build/esm/object/media.test.js +19 -14
  263. package/build/esm/object/media.test.js.map +1 -1
  264. package/build/esm/object/object.test.js +182 -66
  265. package/build/esm/object/object.test.js.map +1 -1
  266. package/build/esm/object/timeseries.test.js +119 -85
  267. package/build/esm/object/timeseries.test.js.map +1 -1
  268. package/build/esm/objectSet/InterfaceObjectSet.test.js +37 -17
  269. package/build/esm/objectSet/InterfaceObjectSet.test.js.map +1 -1
  270. package/build/esm/objectSet/ObjectSet.test.js +212 -114
  271. package/build/esm/objectSet/ObjectSet.test.js.map +1 -1
  272. package/build/esm/objectSet/ObjectSetListenerWebsocket.js +20 -16
  273. package/build/esm/objectSet/ObjectSetListenerWebsocket.js.map +1 -1
  274. package/build/esm/objectSet/ObjectSetListenerWebsocket.test.js +21 -12
  275. package/build/esm/objectSet/ObjectSetListenerWebsocket.test.js.map +1 -1
  276. package/build/esm/objectSet/createObjectSet.js +2 -1
  277. package/build/esm/objectSet/createObjectSet.js.map +1 -1
  278. package/build/esm/observable/ListPayload.js.map +1 -1
  279. package/build/esm/observable/ObjectPayload.js.map +1 -1
  280. package/build/esm/observable/ObservableClient.js.map +1 -1
  281. package/build/esm/observable/OptimisticBuilder.js.map +1 -1
  282. package/build/esm/observable/internal/ActionApplication.js +102 -0
  283. package/build/esm/observable/internal/ActionApplication.js.map +1 -0
  284. package/build/esm/observable/internal/BulkObjectLoader.js +93 -0
  285. package/build/esm/observable/internal/BulkObjectLoader.js.map +1 -0
  286. package/build/esm/observable/internal/BulkObjectLoader.test.js +112 -0
  287. package/build/esm/observable/internal/BulkObjectLoader.test.js.map +1 -0
  288. package/build/esm/observable/internal/CacheKey.js +38 -1
  289. package/build/esm/observable/internal/CacheKey.js.map +1 -1
  290. package/build/esm/observable/internal/CacheKeys.js +4 -4
  291. package/build/esm/observable/internal/CacheKeys.js.map +1 -1
  292. package/build/esm/observable/internal/Changes.js +58 -0
  293. package/build/esm/observable/internal/Changes.js.map +1 -0
  294. package/build/esm/observable/internal/Layer.js +6 -3
  295. package/build/esm/observable/internal/Layer.js.map +1 -1
  296. package/build/esm/observable/internal/ListQuery.js +495 -129
  297. package/build/esm/observable/internal/ListQuery.js.map +1 -1
  298. package/build/esm/observable/internal/ObjectQuery.js +40 -14
  299. package/build/esm/observable/internal/ObjectQuery.js.map +1 -1
  300. package/build/esm/observable/internal/ObservableClientImpl.js +4 -12
  301. package/build/esm/observable/internal/ObservableClientImpl.js.map +1 -1
  302. package/build/esm/observable/internal/OptimisticJob.js +30 -29
  303. package/build/esm/observable/internal/OptimisticJob.js.map +1 -1
  304. package/build/esm/observable/internal/OrderByCanonicalizer.js +73 -0
  305. package/build/esm/observable/internal/OrderByCanonicalizer.js.map +1 -0
  306. package/build/esm/observable/internal/OrderByCanonicalizer.test.js +78 -0
  307. package/build/esm/observable/internal/OrderByCanonicalizer.test.js.map +1 -0
  308. package/build/esm/observable/internal/Query.js +79 -6
  309. package/build/esm/observable/internal/Query.js.map +1 -1
  310. package/build/esm/observable/internal/RefCounts.js +7 -2
  311. package/build/esm/observable/internal/RefCounts.js.map +1 -1
  312. package/build/esm/observable/internal/SimpleWhereClause.js +2 -0
  313. package/build/esm/observable/internal/SimpleWhereClause.js.map +1 -0
  314. package/build/esm/observable/internal/Store.js +140 -190
  315. package/build/esm/observable/internal/Store.js.map +1 -1
  316. package/build/esm/observable/internal/Store.test.js +666 -300
  317. package/build/esm/observable/internal/Store.test.js.map +1 -1
  318. package/build/esm/observable/internal/WhereClauseCanonicalizer.js +11 -3
  319. package/build/esm/observable/internal/WhereClauseCanonicalizer.js.map +1 -1
  320. package/build/esm/observable/internal/objectMatchesWhereClause.js +0 -4
  321. package/build/esm/observable/internal/objectMatchesWhereClause.js.map +1 -1
  322. package/build/esm/observable/internal/objectMatchesWhereClause.test.js.map +1 -1
  323. package/build/esm/observable/internal/testUtils.js +222 -19
  324. package/build/esm/observable/internal/testUtils.js.map +1 -1
  325. package/build/esm/ontology/StandardOntologyProvider.test.js +17 -16
  326. package/build/esm/ontology/StandardOntologyProvider.test.js.map +1 -1
  327. package/build/esm/ontology/loadFullObjectMetadata.js +0 -1
  328. package/build/esm/ontology/loadFullObjectMetadata.js.map +1 -1
  329. package/build/esm/public/internal.js +2 -0
  330. package/build/esm/public/internal.js.map +1 -1
  331. package/build/esm/public/unstable-do-not-use.js +1 -0
  332. package/build/esm/public/unstable-do-not-use.js.map +1 -1
  333. package/build/esm/public-utils/osdkConfig.js +49 -0
  334. package/build/esm/public-utils/osdkConfig.js.map +1 -0
  335. package/build/esm/public-utils/vite-env.d.ts +19 -0
  336. package/build/esm/queries/applyQuery.js +34 -2
  337. package/build/esm/queries/applyQuery.js.map +1 -1
  338. package/build/esm/queries/queries.test.js +36 -13
  339. package/build/esm/queries/queries.test.js.map +1 -1
  340. package/build/esm/queries/types.js.map +1 -1
  341. package/build/esm/tsserver.js.map +1 -1
  342. package/build/esm/util/UserAgent.js +1 -1
  343. package/build/esm/util/UserAgent.js.map +1 -1
  344. package/build/esm/util/extractRdpDefinition.js +140 -0
  345. package/build/esm/util/extractRdpDefinition.js.map +1 -0
  346. package/build/esm/util/extractRdpDefinition.test.js +233 -0
  347. package/build/esm/util/extractRdpDefinition.test.js.map +1 -0
  348. package/build/esm/util/isPoint.js +20 -0
  349. package/build/esm/util/isPoint.js.map +1 -0
  350. package/build/esm/util/objectSpecifierUtils.js +48 -0
  351. package/build/esm/util/objectSpecifierUtils.js.map +1 -0
  352. package/build/esm/util/objectSpecifierUtils.test.js +42 -0
  353. package/build/esm/util/objectSpecifierUtils.test.js.map +1 -0
  354. package/build/esm/util/toDataValue.js +14 -2
  355. package/build/esm/util/toDataValue.js.map +1 -1
  356. package/build/esm/util/toDataValue.test.js +37 -16
  357. package/build/esm/util/toDataValue.test.js.map +1 -1
  358. package/build/esm/util/toDataValueQueries.js +25 -2
  359. package/build/esm/util/toDataValueQueries.js.map +1 -1
  360. package/build/types/Client.d.ts +1 -1
  361. package/build/types/Client.d.ts.map +1 -1
  362. package/build/types/MinimalClientContext.d.ts +1 -1
  363. package/build/types/MinimalClientContext.d.ts.map +1 -1
  364. package/build/types/__unstable/ConjureSupport.d.ts +2 -2
  365. package/build/types/actions/applyAction.d.ts +1 -2
  366. package/build/types/actions/applyAction.d.ts.map +1 -1
  367. package/build/types/createClient.d.ts +1 -1
  368. package/build/types/createClient.d.ts.map +1 -1
  369. package/build/types/createClient.test.d.ts +2 -1
  370. package/build/types/createClient.test.d.ts.map +1 -1
  371. package/build/types/createMinimalClientHelper.d.ts +1 -0
  372. package/build/types/createMinimalClientHelper.d.ts.map +1 -0
  373. package/build/types/derivedProperties/derivedPropertyDefinitionFactory.d.ts +1 -0
  374. package/build/types/derivedProperties/derivedPropertyDefinitionFactory.d.ts.map +1 -0
  375. package/build/types/index.d.ts +5 -5
  376. package/build/types/index.d.ts.map +1 -1
  377. package/build/types/intellisense.test.helpers/showsObjectPropertyJsdoc.d.ts +1 -0
  378. package/build/types/intellisense.test.helpers/showsObjectPropertyJsdoc.d.ts.map +1 -0
  379. package/build/types/logger/BaseLogger.d.ts +33 -0
  380. package/build/types/logger/BaseLogger.d.ts.map +1 -0
  381. package/build/types/logger/BrowserLogger.d.ts +9 -0
  382. package/build/types/logger/BrowserLogger.d.ts.map +1 -0
  383. package/build/types/logger/MinimalLogger.d.ts +9 -0
  384. package/build/types/logger/MinimalLogger.d.ts.map +1 -0
  385. package/build/types/logger/MinimalLogger.test.d.ts +1 -0
  386. package/build/types/logger/MinimalLogger.test.d.ts.map +1 -0
  387. package/build/types/logger/TestLogger.d.ts +14 -0
  388. package/build/types/logger/TestLogger.d.ts.map +1 -0
  389. package/build/types/object/AttachmentUpload.d.ts +3 -0
  390. package/build/types/object/AttachmentUpload.d.ts.map +1 -1
  391. package/build/types/object/SimpleOsdkProperties.d.ts +1 -0
  392. package/build/types/object/SimpleOsdkProperties.d.ts.map +1 -0
  393. package/build/types/object/convertWireToOsdkObjects/BaseHolder.d.ts +1 -0
  394. package/build/types/object/convertWireToOsdkObjects/BaseHolder.d.ts.map +1 -0
  395. package/build/types/object/convertWireToOsdkObjects.d.ts +8 -1
  396. package/build/types/object/convertWireToOsdkObjects.d.ts.map +1 -1
  397. package/build/types/object/fetchPage.d.ts.map +1 -1
  398. package/build/types/object/object.test.d.ts.map +1 -1
  399. package/build/types/objectSet/ObjectSet.test.d.ts.map +1 -1
  400. package/build/types/observable/ListPayload.d.ts +5 -9
  401. package/build/types/observable/ListPayload.d.ts.map +1 -1
  402. package/build/types/observable/ObjectPayload.d.ts +4 -7
  403. package/build/types/observable/ObjectPayload.d.ts.map +1 -1
  404. package/build/types/observable/ObservableClient.d.ts +33 -10
  405. package/build/types/observable/ObservableClient.d.ts.map +1 -1
  406. package/build/types/observable/OptimisticBuilder.d.ts +1 -1
  407. package/build/types/observable/OptimisticBuilder.d.ts.map +1 -1
  408. package/build/types/observable/internal/ActionApplication.d.ts +9 -0
  409. package/build/types/observable/internal/ActionApplication.d.ts.map +1 -0
  410. package/build/types/observable/internal/BulkObjectLoader.d.ts +8 -0
  411. package/build/types/observable/internal/BulkObjectLoader.d.ts.map +1 -0
  412. package/build/types/observable/internal/BulkObjectLoader.test.d.ts +1 -0
  413. package/build/types/observable/internal/BulkObjectLoader.test.d.ts.map +1 -0
  414. package/build/types/observable/internal/CacheKeys.d.ts +2 -1
  415. package/build/types/observable/internal/CacheKeys.d.ts.map +1 -1
  416. package/build/types/observable/internal/Changes.d.ts +15 -0
  417. package/build/types/observable/internal/Changes.d.ts.map +1 -0
  418. package/build/types/observable/internal/Layer.d.ts +2 -1
  419. package/build/types/observable/internal/Layer.d.ts.map +1 -1
  420. package/build/types/observable/internal/ListQuery.d.ts +69 -23
  421. package/build/types/observable/internal/ListQuery.d.ts.map +1 -1
  422. package/build/types/observable/internal/ObjectQuery.d.ts +8 -9
  423. package/build/types/observable/internal/ObjectQuery.d.ts.map +1 -1
  424. package/build/types/observable/internal/OptimisticJob.d.ts +2 -2
  425. package/build/types/observable/internal/OptimisticJob.d.ts.map +1 -1
  426. package/build/types/observable/internal/OrderByCanonicalizer.d.ts +12 -0
  427. package/build/types/observable/internal/OrderByCanonicalizer.d.ts.map +1 -0
  428. package/build/types/observable/internal/OrderByCanonicalizer.test.d.ts +1 -0
  429. package/build/types/observable/internal/OrderByCanonicalizer.test.d.ts.map +1 -0
  430. package/build/types/observable/internal/Query.d.ts +45 -9
  431. package/build/types/observable/internal/Query.d.ts.map +1 -1
  432. package/build/types/observable/internal/RefCounts.d.ts.map +1 -1
  433. package/build/types/observable/internal/SimpleWhereClause.d.ts +2 -0
  434. package/build/types/observable/internal/SimpleWhereClause.d.ts.map +1 -0
  435. package/build/types/observable/internal/Store.d.ts +34 -30
  436. package/build/types/observable/internal/Store.d.ts.map +1 -1
  437. package/build/types/observable/internal/WhereClauseCanonicalizer.d.ts +2 -1
  438. package/build/types/observable/internal/WhereClauseCanonicalizer.d.ts.map +1 -1
  439. package/build/types/observable/internal/objectMatchesWhereClause.d.ts +4 -2
  440. package/build/types/observable/internal/objectMatchesWhereClause.d.ts.map +1 -1
  441. package/build/types/observable/internal/testUtils.d.ts +48 -9
  442. package/build/types/observable/internal/testUtils.d.ts.map +1 -1
  443. package/build/types/public/internal.d.ts +2 -0
  444. package/build/types/public/internal.d.ts.map +1 -1
  445. package/build/types/public/unstable-do-not-use.d.ts +4 -5
  446. package/build/types/public/unstable-do-not-use.d.ts.map +1 -1
  447. package/build/types/public-utils/osdkConfig.d.ts +8 -0
  448. package/build/types/public-utils/osdkConfig.d.ts.map +1 -0
  449. package/build/types/public-utils/vite-env.d.d.ts +3 -0
  450. package/build/types/public-utils/vite-env.d.d.ts.map +1 -0
  451. package/build/types/queries/applyQuery.d.ts +4 -2
  452. package/build/types/queries/applyQuery.d.ts.map +1 -1
  453. package/build/types/queries/types.d.ts +1 -1
  454. package/build/types/queries/types.d.ts.map +1 -1
  455. package/build/types/tsserver.d.ts +1 -1
  456. package/build/types/tsserver.d.ts.map +1 -1
  457. package/build/types/util/extractRdpDefinition.d.ts +4 -0
  458. package/build/types/util/extractRdpDefinition.d.ts.map +1 -0
  459. package/build/types/util/extractRdpDefinition.test.d.ts +1 -0
  460. package/build/types/util/extractRdpDefinition.test.d.ts.map +1 -0
  461. package/build/types/util/isPoint.d.ts +1 -0
  462. package/build/types/util/isPoint.d.ts.map +1 -0
  463. package/build/types/util/objectSpecifierUtils.d.ts +24 -0
  464. package/build/types/util/objectSpecifierUtils.d.ts.map +1 -0
  465. package/build/types/util/objectSpecifierUtils.test.d.ts +1 -0
  466. package/build/types/util/objectSpecifierUtils.test.d.ts.map +1 -0
  467. package/package.json +20 -16
  468. package/build/browser/Logger.js +0 -2
  469. package/build/browser/Logger.js.map +0 -1
  470. package/build/browser/observable/internal/ChangedObjects.js.map +0 -1
  471. package/build/cjs/chunk-Q7SFCCGT.cjs +0 -11
  472. package/build/cjs/chunk-Q7SFCCGT.cjs.map +0 -1
  473. package/build/cjs/chunk-T5UE6BI7.cjs.map +0 -1
  474. package/build/cjs/chunk-X7WGNFZ4.cjs.map +0 -1
  475. package/build/cjs/graphql-JJX5MZPQ.cjs +0 -10491
  476. package/build/cjs/graphql-JJX5MZPQ.cjs.map +0 -1
  477. package/build/esm/Logger.js +0 -2
  478. package/build/esm/Logger.js.map +0 -1
  479. package/build/esm/observable/internal/ChangedObjects.js.map +0 -1
  480. package/build/types/Logger.d.ts +0 -18
  481. package/build/types/Logger.d.ts.map +0 -1
  482. package/build/types/observable/internal/ChangedObjects.d.ts +0 -7
  483. package/build/types/observable/internal/ChangedObjects.d.ts.map +0 -1
@@ -15,32 +15,140 @@
15
15
  */
16
16
 
17
17
  import deepEqual from "fast-deep-equal";
18
- import { asyncScheduler, auditTime, combineLatest, connectable, map, mergeMap, observeOn, of, ReplaySubject } from "rxjs";
18
+ import groupBy from "object.groupby";
19
+ import { auditTime, combineLatest, connectable, map, of, ReplaySubject, switchMap } from "rxjs";
19
20
  import invariant from "tiny-invariant";
20
- import { Entry } from "./Layer.js";
21
- import { objectSortaMatchesWhereClause } from "./objectMatchesWhereClause.js";
21
+ import { additionalContext } from "../../Client.js";
22
+ import { ObjectDefRef, UnderlyingOsdkObject } from "../../object/convertWireToOsdkObjects/InternalSymbols.js";
23
+ import { DEBUG_ONLY__cacheKeysToString } from "./CacheKey.js";
24
+ import { DEBUG_ONLY__changesToString } from "./Changes.js";
25
+ import { objectSortaMatchesWhereClause as objectMatchesWhereClause } from "./objectMatchesWhereClause.js";
26
+ import { storeOsdkInstances } from "./ObjectQuery.js";
22
27
  import { Query } from "./Query.js";
23
- auditTime(0);
24
- export class ListQuery extends Query {
28
+ export const API_NAME_IDX = 1;
29
+ export const TYPE_IDX = 0;
30
+ export const WHERE_IDX = 2;
31
+ export const ORDER_BY_IDX = 3;
32
+ class BaseListQuery extends Query {
33
+ //
34
+ // Per list type implementations
35
+ //
36
+
37
+ //
38
+ // Shared Implementations
39
+ //
40
+
41
+ /**
42
+ * Only intended to be "protected" and used by subclasses but exposed for
43
+ * testing.
44
+ *
45
+ * @param objectCacheKeys
46
+ * @param append
47
+ * @param status
48
+ * @param batch
49
+ * @returns
50
+ */
51
+ _updateList(objectCacheKeys, append, status, batch) {
52
+ if (process.env.NODE_ENV !== "production") {
53
+ const logger = process.env.NODE_ENV !== "production" ? this.logger?.child({
54
+ methodName: "updateList"
55
+ }) : this.logger;
56
+ logger?.debug(`{status: ${status}}`, JSON.stringify(objectCacheKeys, null, 2));
57
+ }
58
+ objectCacheKeys = this.#retainReleaseAppend(batch, append, objectCacheKeys);
59
+ objectCacheKeys = this._sortCacheKeys(objectCacheKeys, batch);
60
+ objectCacheKeys = removeDuplicates(objectCacheKeys, batch);
61
+ return this.writeToStore({
62
+ data: objectCacheKeys
63
+ }, status, batch);
64
+ }
65
+ writeToStore(data, status, batch) {
66
+ const entry = batch.read(this.cacheKey);
67
+ if (entry && deepEqual(data, entry.value)) {
68
+ if (process.env.NODE_ENV !== "production") {
69
+ this.logger?.child({
70
+ methodName: "writeToStore"
71
+ }).debug(`Object was deep equal, just setting status`);
72
+ }
73
+ return batch.write(this.cacheKey, entry.value, status);
74
+ }
75
+ if (process.env.NODE_ENV !== "production") {
76
+ this.logger?.child({
77
+ methodName: "writeToStore"
78
+ }).debug(`{status: ${status}},`, DEBUG_ONLY__cacheKeysToString(data.data));
79
+ }
80
+ const ret = batch.write(this.cacheKey, data, status);
81
+ batch.changes.registerList(this.cacheKey);
82
+ return ret;
83
+ }
84
+ #retainReleaseAppend(batch, append, objectCacheKeys) {
85
+ const existingList = batch.read(this.cacheKey);
86
+
87
+ // whether its append or update we need to retain all the new objects
88
+ if (!batch.optimisticWrite) {
89
+ if (!append) {
90
+ // we need to release all the old objects
91
+ // N.B. the store keeps the cache keys around for a bit so we don't
92
+ // need to worry about them being GC'd before we re-retain them
93
+ for (const objectCacheKey of existingList?.value?.data ?? []) {
94
+ this.store.release(objectCacheKey);
95
+ }
96
+ }
97
+ for (const objectCacheKey of objectCacheKeys) {
98
+ this.store.retain(objectCacheKey);
99
+ }
100
+ }
101
+ if (append) {
102
+ objectCacheKeys = [...(existingList?.value?.data ?? []), ...objectCacheKeys];
103
+ }
104
+ return objectCacheKeys;
105
+ }
106
+ _dispose() {
107
+ // eslint-disable-next-line no-console
108
+ console.log("DISPOSE LIST QUERY");
109
+ this.store.batch({}, batch => {
110
+ const entry = batch.read(this.cacheKey);
111
+ if (entry) {
112
+ for (const objectCacheKey of entry.value?.data ?? []) {
113
+ this.store.release(objectCacheKey);
114
+ }
115
+ }
116
+ });
117
+ }
118
+ }
119
+ export class ListQuery extends BaseListQuery {
25
120
  // pageSize?: number; // this is the internal page size. we need to track this properly
26
- #client;
121
+
27
122
  #type;
123
+ #apiName;
28
124
  #whereClause;
29
125
 
30
126
  // this represents the minimum number of results we need to load if we revalidate
31
127
  #minNumResults = 0;
32
128
  #nextPageToken;
33
129
  #pendingPageFetch;
34
- #toRelease = new Set();
35
- constructor(store, subject, type, whereClause, cacheKey, opts) {
36
- super(store, subject, opts, cacheKey);
37
- this.#client = store.client;
38
- this.#type = type;
130
+ #orderBy;
131
+ #objectSet;
132
+ #sortFns;
133
+ constructor(store, subject, apiType, apiName, whereClause, orderBy, cacheKey, opts) {
134
+ super(store, subject, opts, cacheKey, process.env.NODE_ENV !== "production" ? store.client[additionalContext].logger?.child({}, {
135
+ msgPrefix: `ListQuery<${cacheKey.otherKeys.map(x => JSON.stringify(x)).join(", ")}>`
136
+ }) : undefined);
137
+ this.#type = apiType;
138
+ this.#apiName = apiName;
39
139
  this.#whereClause = whereClause;
40
- observeOn(asyncScheduler);
140
+ this.#orderBy = orderBy;
141
+ this.#objectSet = store.client({
142
+ type: this.#type,
143
+ apiName: this.#apiName
144
+ }).where(this.#whereClause);
145
+ this.#sortFns = createOrderBySortFns(this.#orderBy);
146
+ }
147
+ get canonicalWhere() {
148
+ return this.#whereClause;
41
149
  }
42
150
  _createConnectable(subject) {
43
- return connectable(subject.pipe(mergeMap(listEntry => {
151
+ return connectable(subject.pipe(switchMap(listEntry => {
44
152
  return combineLatest({
45
153
  resolvedList: listEntry?.value?.data == null ? of([]) : combineLatest(listEntry.value.data.map(cacheKey => this.store.getSubject(cacheKey).pipe(map(objectEntry => objectEntry?.value)))),
46
154
  isOptimistic: of(listEntry.isOptimistic),
@@ -59,13 +167,14 @@ export class ListQuery extends Query {
59
167
  _preFetch() {
60
168
  this.#nextPageToken = undefined;
61
169
  }
62
- async _fetch() {
63
- const objectSet = this.#client({
64
- type: "object",
65
- apiName: this.#type
66
- }).where(this.#whereClause);
170
+ async _fetchAndStore() {
171
+ if (process.env.NODE_ENV !== "production") {
172
+ this.logger?.child({
173
+ methodName: "_fetchAndStore"
174
+ }).info("fetching pages");
175
+ }
67
176
  while (true) {
68
- const entry = await this.#fetchPageAndUpdate(objectSet, "loading", this.abortController?.signal);
177
+ const entry = await this.#fetchPageAndUpdate(this.#objectSet, "loading", this.abortController?.signal);
69
178
  if (!entry) {
70
179
  // we were aborted
71
180
  return;
@@ -98,153 +207,410 @@ export class ListQuery extends Query {
98
207
  this.store.batch({}, batch => {
99
208
  this.setStatus("loading", batch);
100
209
  });
101
- const objectSet = this.#client({
102
- type: "object",
103
- apiName: this.#type
104
- }).where(this.#whereClause);
105
- this.pendingFetch = this.#fetchPageAndUpdate(objectSet, "loaded", this.abortController?.signal).finally(() => {
210
+ this.pendingFetch = this.#fetchPageAndUpdate(this.#objectSet, "loaded", this.abortController?.signal).finally(() => {
106
211
  this.#pendingPageFetch = undefined;
107
212
  });
108
213
  return this.pendingFetch;
109
214
  };
110
215
  async #fetchPageAndUpdate(objectSet, status, signal) {
111
216
  const append = this.#nextPageToken != null;
112
- const {
113
- data,
114
- nextPageToken
115
- } = await objectSet.fetchPage({
116
- $nextPageToken: this.#nextPageToken,
117
- $pageSize: this.options.pageSize
118
- });
119
- if (signal?.aborted) {
120
- return;
121
- }
122
- this.#nextPageToken = nextPageToken;
123
- const {
124
- retVal
125
- } = this.store.batch({}, batch => {
126
- return this.updateList(data, append, nextPageToken ? status : "loaded", batch);
127
- });
128
- return retVal;
217
+ try {
218
+ let {
219
+ data,
220
+ nextPageToken
221
+ } = await objectSet.fetchPage({
222
+ $nextPageToken: this.#nextPageToken,
223
+ $pageSize: this.options.pageSize,
224
+ // For now this keeps the shared test code from falling apart
225
+ // but shouldn't be needed ideally
226
+ ...(Object.keys(this.#orderBy).length > 0 ? {
227
+ $orderBy: this.#orderBy
228
+ } : {})
229
+ });
230
+ if (signal?.aborted) {
231
+ return;
232
+ }
233
+ this.#nextPageToken = nextPageToken;
234
+
235
+ // Our caching really expects to have the full objects in the list
236
+ // so we need to fetch them all here
237
+ if (this.#type === "interface") {
238
+ data = await reloadDataAsFullObjects(this.store.client, data);
239
+ }
240
+ const {
241
+ retVal
242
+ } = this.store.batch({}, batch => {
243
+ return this._updateList(storeOsdkInstances(this.store, data, batch), append, nextPageToken ? status : "loaded", batch);
244
+ });
245
+ return retVal;
246
+ } catch (e) {
247
+ this.logger?.error("error", e);
248
+ this.store.getSubject(this.cacheKey).error(e);
249
+
250
+ // rethrowing would result in many unhandled promise rejections
251
+ // which i don't think we want
252
+ // throw e;
253
+ }
129
254
  }
130
255
 
131
256
  /**
132
- * Caller is responsible for removing the layer
257
+ * Will revalidate the list if its query is affected by invalidating the
258
+ * apiName of the object type passed in.
133
259
  *
134
- * @param changedObjects
135
- * @param optimisticId
260
+ * @param apiName to invalidate
136
261
  * @returns
137
262
  */
138
- maybeUpdate(changedObjects, optimisticId) {
139
- let needsRevalidation = false;
140
- const objectsToInsert = [];
141
- for (const [type, objects] of changedObjects.addedObjects.associations()) {
142
- if (this.cacheKey.otherKeys[0] !== type) {
143
- continue;
144
- }
145
- for (const obj of objects) {
146
- // strict match means it didn't use a filter we cannot use on the frontend
147
- const strictMatch = objectSortaMatchesWhereClause(obj, this.#whereClause, true);
148
- if (strictMatch) {
149
- objectsToInsert.push(obj);
150
- } else {
151
- // sorta match means it used a filter we cannot use on the frontend
152
- const sortaMatch = objectSortaMatchesWhereClause(obj, this.#whereClause, false);
153
- if (sortaMatch) {
154
- needsRevalidation = true;
155
- }
156
- }
263
+ revalidateObjectType = async apiName => {
264
+ if (this.#type === "object") {
265
+ if (this.#apiName === apiName) {
266
+ await this.revalidate(/* force */true);
267
+ return;
268
+ } else {
269
+ return;
157
270
  }
158
271
  }
159
- needsRevalidation ||= objectsToInsert.length > 0;
160
- if (objectsToInsert.length > 0) {
161
- // for now we are not doing sorting which makes life easy :)
162
- // FIXME
272
+ //
273
+ const objectMetadata = await this.store.client.fetchMetadata({
274
+ type: "object",
275
+ apiName
276
+ });
277
+ if (this.#apiName in objectMetadata.interfaceMap) {
278
+ await this.revalidate(/* force */true);
279
+ }
280
+ };
163
281
 
282
+ /**
283
+ * Note: This method is not async because I want it to return right after it
284
+ * finishes the synchronous updates. The promise that is returned
285
+ * will resolve after the revalidation is complete.
286
+ * @param changes
287
+ * @param optimisticId
288
+ * @returns If revalidation is needed, a promise that resolves after the
289
+ * revalidation is complete. Otherwise, undefined.
290
+ */
291
+
292
+ maybeUpdateAndRevalidate = (changes, optimisticId) => {
293
+ if (process.env.NODE_ENV !== "production") {
294
+ this.logger?.child({
295
+ methodName: "maybeUpdateAndRevalidate"
296
+ }).debug(DEBUG_ONLY__changesToString(changes));
297
+ }
298
+ if (changes.modified.has(this.cacheKey)) return;
299
+ // mark ourselves as updated so we don't infinite recurse.
300
+ changes.modified.add(this.cacheKey);
301
+ try {
302
+ const relevantObjects = this._extractRelevantObjects(changes);
303
+ if (relevantObjects.added.all.length === 0 && relevantObjects.modified.all.length === 0) {
304
+ return;
305
+ }
306
+
307
+ // If we got purely strict matches we can just update the list and move
308
+ // on with our lives. But if we got sorta matches, then we need to revalidate
309
+ // the list so we preemptively set it to loading to avoid thrashing the store.
310
+ const status = optimisticId || relevantObjects.added.sortaMatches.size > 0 || relevantObjects.modified.sortaMatches.size > 0 ? "loading" : "loaded";
311
+
312
+ // while we only push updates for the strict matches, we still need to
313
+ // trigger the list updating if some of our objects changed
314
+
315
+ const newList = [];
316
+ let needsRevalidation = false;
164
317
  this.store.batch({
165
- optimisticId
318
+ optimisticId,
319
+ changes
166
320
  }, batch => {
167
- this.updateList(objectsToInsert, true, "loading", batch);
321
+ const existingList = new Set(batch.read(this.cacheKey)?.value?.data);
322
+ const toAdd = new Set(
323
+ // easy case. objects are new to the cache and they match this filter
324
+ relevantObjects.added.strictMatches);
325
+ const toRemove = new Set();
326
+
327
+ // deal with the modified objects
328
+ for (const obj of relevantObjects.modified.all) {
329
+ if (relevantObjects.modified.strictMatches.has(obj)) {
330
+ const objectCacheKey = this.store.getCacheKey("object", obj.$objectType, obj.$primaryKey);
331
+ if (!existingList.has(objectCacheKey)) {
332
+ // object is new to the list
333
+ toAdd.add(obj);
334
+ }
335
+ continue;
336
+ } else if (batch.optimisticWrite) {
337
+ // we aren't removing objects in optimistic mode
338
+ // we also don't want to trigger revalidation in optimistic mode
339
+ // as it should be triggered when the optimistic job is done
340
+ continue;
341
+ } else {
342
+ // object is no longer a strict match
343
+ const existingObjectCacheKey = this.store.getCacheKey("object", obj.$objectType, obj.$primaryKey);
344
+ toRemove.add(existingObjectCacheKey);
345
+ if (relevantObjects.modified.sortaMatches.has(obj)) {
346
+ // since it might still be in the list we need to revalidate
347
+ needsRevalidation = true;
348
+ }
349
+ }
350
+ }
351
+ for (const key of existingList) {
352
+ if (toRemove.has(key)) continue;
353
+ newList.push(key);
354
+ }
355
+ for (const obj of toAdd) {
356
+ newList.push(this.store.getCacheKey("object", obj.$objectType, obj.$primaryKey));
357
+ }
358
+ this._updateList(newList, /* append */false, status, batch);
168
359
  });
169
- }
170
- return needsRevalidation;
171
- }
172
- maybeRevalidate(changedObjects) {
173
- let needsRevalidation = false;
174
- for (const [type, objects] of changedObjects.addedObjects.associations()) {
175
- if (this.cacheKey.otherKeys[0] !== type) {
176
- continue;
360
+ if (needsRevalidation) {
361
+ return this.revalidate(true);
177
362
  }
178
- for (const obj of objects) {
179
- // sorta match means it used a filter we cannot use on the frontend
180
- const sortaMatch = objectSortaMatchesWhereClause(obj, this.#whereClause, false);
181
- if (sortaMatch) {
182
- needsRevalidation = true;
183
- }
363
+ return undefined;
364
+ } finally {
365
+ if (process.env.NODE_ENV !== "production") {
366
+ this.logger?.child({
367
+ methodName: "maybeUpdateAndRevalidate"
368
+ }).debug("in finally");
184
369
  }
185
370
  }
186
- if (needsRevalidation) {
187
- return this.revalidate(true);
188
- }
189
- return Promise.resolve();
190
- }
191
- updateList(values, append, status, batch) {
192
- // update the cache for any object that has changed
193
- // and save the mapped values to return
194
- let objectCacheKeys = values.map(v => {
195
- if (v instanceof Entry) return v.cacheKey;
196
- this.store.getObjectQuery(this.#type, v.$primaryKey).writeToStore(v, "loaded", batch);
197
- return this.store.getCacheKey("object", v.$apiName, v.$primaryKey);
198
- });
199
- const existingList = batch.read(this.cacheKey);
371
+ };
372
+ _extractRelevantObjects(changes) {
373
+ // TODO refactor this ternary into subclasses
374
+ const relevantObjects = this.#type === "object" ? this.#extractRelevantObjectsForTypeObject(changes) : this.#extractRelevantObjectsForTypeInterface(changes);
200
375
 
201
- // whether its append or update we need to retain all the new objects
202
- if (!batch.optimisticWrite) {
203
- if (!append) {
204
- // we need to release all the old objects
205
- for (const objectCacheKey of existingList?.value?.data ?? []) {
206
- this.store.release(objectCacheKey);
207
- this.#toRelease.delete(objectCacheKey);
376
+ // categorize
377
+ for (const group of Object.values(relevantObjects)) {
378
+ for (const obj of group.all ?? []) {
379
+ // if its a strict match we can just insert it into place
380
+ const strictMatch = objectMatchesWhereClause(obj, this.#whereClause, true);
381
+ if (strictMatch) {
382
+ group.strictMatches.add(obj);
383
+ } else {
384
+ // sorta match means it used a filter we cannot use on the frontend
385
+ const sortaMatch = objectMatchesWhereClause(obj, this.#whereClause, false);
386
+ if (sortaMatch) {
387
+ group.sortaMatches.add(obj);
388
+ }
208
389
  }
209
390
  }
210
- for (const objectCacheKey of objectCacheKeys) {
211
- this.#toRelease.add(objectCacheKey);
212
- this.store.retain(objectCacheKey);
391
+ }
392
+ return relevantObjects;
393
+ }
394
+ #extractRelevantObjectsForTypeInterface(changes) {
395
+ const added = Array.from(changes.addedObjects).filter(([, object]) => {
396
+ return this.#apiName in object[ObjectDefRef].interfaceMap;
397
+ }).map(([, object]) => object.$as(this.#apiName));
398
+ const modified = Array.from(changes.modifiedObjects).filter(([, object]) => {
399
+ return this.#apiName in object[ObjectDefRef].interfaceMap;
400
+ }).map(([, object]) => object.$as(this.#apiName));
401
+ return {
402
+ added: {
403
+ all: added,
404
+ strictMatches: new Set(),
405
+ sortaMatches: new Set()
406
+ },
407
+ modified: {
408
+ all: modified,
409
+ strictMatches: new Set(),
410
+ sortaMatches: new Set()
411
+ }
412
+ };
413
+ }
414
+ #extractRelevantObjectsForTypeObject(changes) {
415
+ return {
416
+ added: {
417
+ all: changes.addedObjects.get(this.cacheKey.otherKeys[API_NAME_IDX]) ?? [],
418
+ strictMatches: new Set(),
419
+ sortaMatches: new Set()
420
+ },
421
+ modified: {
422
+ all: changes.modifiedObjects.get(this.cacheKey.otherKeys[API_NAME_IDX]) ?? [],
423
+ strictMatches: new Set(),
424
+ sortaMatches: new Set()
213
425
  }
426
+ };
427
+ }
428
+ _sortCacheKeys(objectCacheKeys, batch) {
429
+ if (Object.keys(this.#orderBy).length > 0) {
430
+ objectCacheKeys = objectCacheKeys.sort((a, b) => {
431
+ for (const sortFn of this.#sortFns) {
432
+ const ret = sortFn(batch.read(a)?.value?.$as(this.#apiName), batch.read(b)?.value?.$as(this.#apiName));
433
+ if (ret !== 0) {
434
+ return ret;
435
+ }
436
+ }
437
+ return 0;
438
+ });
439
+ }
440
+ return objectCacheKeys;
441
+ }
442
+ registerStreamUpdates(sub) {
443
+ const logger = process.env.NODE_ENV !== "production" ? this.logger?.child({
444
+ methodName: "registerStreamUpdates"
445
+ }) : this.logger;
446
+ if (process.env.NODE_ENV !== "production") {
447
+ logger?.child({
448
+ methodName: "observeList"
449
+ }).info("Subscribing from websocket");
214
450
  }
215
451
 
216
- // EA TODO: I think we need to do more here.
452
+ // FIXME: We should only do this once. If we already have one we should probably
453
+ // just reuse it.
217
454
 
218
- if (append) {
219
- objectCacheKeys = [...(existingList?.value?.data ?? []), ...objectCacheKeys];
455
+ const websocketSubscription = this.#objectSet.subscribe({
456
+ onChange: this.#onOswChange.bind(this),
457
+ onError: this.#onOswError.bind(this),
458
+ onOutOfDate: this.#onOswOutOfDate.bind(this),
459
+ onSuccessfulSubscription: this.#onOswSuccessfulSubscription.bind(this)
460
+ });
461
+ sub.add(() => {
462
+ if (process.env.NODE_ENV !== "production") {
463
+ logger?.child({
464
+ methodName: "observeList"
465
+ }).info("Unsubscribing from websocket");
466
+ }
467
+ websocketSubscription.unsubscribe();
468
+ });
469
+ }
470
+ #onOswSuccessfulSubscription() {
471
+ if (process.env.NODE_ENV !== "production") {
472
+ this.logger?.child({
473
+ methodName: "onSuccessfulSubscription"
474
+ }).debug("");
220
475
  }
221
- return this.writeToStore({
222
- data: objectCacheKeys
223
- }, status, batch);
224
476
  }
225
- writeToStore(data, status, batch) {
226
- const entry = batch.read(this.cacheKey);
227
- if (entry && deepEqual(data, entry.value)) {
228
- return batch.write(this.cacheKey, entry.value, status);
477
+ #onOswOutOfDate() {
478
+ if (process.env.NODE_ENV !== "production") {
479
+ this.logger?.child({
480
+ methodName: "onOutOfDate"
481
+ }).info("");
229
482
  }
230
- const ret = batch.write(this.cacheKey, data, status);
231
- batch.modifiedLists.add(this.cacheKey);
232
- return ret;
233
483
  }
234
- _dispose() {
235
- // eslint-disable-next-line no-console
236
- console.log("DISPOSE LIST QUERY");
484
+ #onOswError(errors) {
485
+ if (this.logger) {
486
+ this.logger?.child({
487
+ methodName: "onError"
488
+ }).error("subscription errors", errors);
489
+ }
490
+ }
491
+ #onOswChange({
492
+ object: objOrIface,
493
+ state
494
+ }) {
495
+ const logger = process.env.NODE_ENV !== "production" ? this.logger?.child({
496
+ methodName: "registerStreamUpdates"
497
+ }) : this.logger;
498
+ if (process.env.NODE_ENV !== "production") {
499
+ logger?.child({
500
+ methodName: "onChange"
501
+ }).debug(`Got an update of type: ${state}`, objOrIface);
502
+ }
503
+ if (state === "ADDED_OR_UPDATED") {
504
+ const object = objOrIface.$apiName !== objOrIface.$objectType ? objOrIface.$as(objOrIface.$objectType) : objOrIface;
505
+ this.store.batch({}, batch => {
506
+ storeOsdkInstances(this.store, [object], batch);
507
+ });
508
+ } else if (state === "REMOVED") {
509
+ this.#onOswRemoved(objOrIface, logger);
510
+ }
511
+ }
512
+ #onOswRemoved(objOrIface, logger) {
237
513
  this.store.batch({}, batch => {
238
- const entry = batch.read(this.cacheKey);
239
- if (entry) {
240
- for (const objectCacheKey of entry.value?.data ?? []) {
241
- this.store.release(objectCacheKey);
514
+ // Read the truth layer (since not optimistic)
515
+ const existing = batch.read(this.cacheKey);
516
+ !existing ? process.env.NODE_ENV !== "production" ? invariant(false, "the truth value for our list should exist as we already subscribed") : invariant(false) : void 0;
517
+ if (existing.status === "loaded") {
518
+ const objectCacheKey = this.store.getCacheKey("object", objOrIface.$objectType, objOrIface.$primaryKey);
519
+ // remove the object from the list
520
+ const newObjects = existing.value?.data.filter(o => o !== objectCacheKey);
521
+
522
+ // If the filter didn't change anything, then the list was already
523
+ // updated (or didn't exist, which is nonsensical)
524
+ if (newObjects?.length !== existing.value?.data.length) {
525
+ batch.changes.registerList(this.cacheKey);
526
+ batch.write(this.cacheKey, {
527
+ data: newObjects ?? []
528
+ }, "loaded");
529
+ // Should there be an else for this case? Do we need to invalidate
530
+ // the paging tokens we may have? FIXME
242
531
  }
532
+ return;
243
533
  }
534
+ // There may be a tiny race here where OSW tells us the object has
535
+ // been removed but an outstanding invalidation of this query is
536
+ // about to return. In this case, its possible that we remove this item
537
+ // from the list and then the returned list load re-adds it.
538
+ // To avoid this, we will just force reload the query to be sure
539
+ // we don't leave things in a bad state.
540
+ if (process.env.NODE_ENV !== "production") {
541
+ logger?.info("Removing an object from an object list that is in the middle of being loaded.", existing);
542
+ }
543
+ this.revalidate(/* force */true).catch(e => {
544
+ if (logger) {
545
+ logger?.error("Uncaught error while revalidating list", e);
546
+ } else {
547
+ // Make sure we write to the console if there is no logger!
548
+ // eslint-disable-next-line no-console
549
+ console.error("Uncaught error while revalidating list", e);
550
+ }
551
+ });
244
552
  });
245
553
  }
246
554
  }
247
- export function isListCacheKey(cacheKey, apiName) {
248
- return cacheKey.type === "list" && (apiName == null || cacheKey.otherKeys[0] === apiName);
555
+ function removeDuplicates(objectCacheKeys, batch) {
556
+ const visited = new Set();
557
+ objectCacheKeys = objectCacheKeys.filter(key => {
558
+ batch.read(key);
559
+ if (visited.has(key)) {
560
+ return false;
561
+ }
562
+ visited.add(key);
563
+ return true;
564
+ });
565
+ return objectCacheKeys;
249
566
  }
567
+ function createOrderBySortFns(orderBy) {
568
+ return Object.entries(orderBy).map(([key, order]) => {
569
+ return (a, b) => {
570
+ const aValue = a?.[key];
571
+ const bValue = b?.[key];
572
+ if (aValue == null && bValue == null) {
573
+ return 0;
574
+ }
575
+ if (aValue == null) {
576
+ return 1;
577
+ }
578
+ if (bValue == null) {
579
+ return -1;
580
+ }
581
+ const m = order === "asc" ? -1 : 1;
582
+ return aValue < bValue ? m : aValue > bValue ? -m : 0;
583
+ };
584
+ });
585
+ }
586
+
587
+ // Hopefully this can go away when we can just request the full object properties on first load
588
+ async function reloadDataAsFullObjects(client, data) {
589
+ const groups = groupBy(data, x => x.$objectType);
590
+ const objectTypeToPrimaryKeyToObject = Object.fromEntries(await Promise.all(Object.entries(groups).map(async ([apiName, objects]) => {
591
+ // to keep InternalSimpleOsdkInstance simple, we make both the `ObjectDefRef` and
592
+ // the `InterfaceDefRef` optional but we know that the right one is on there
593
+ // thus we can `!`
594
+ const objectDef = objects[0][UnderlyingOsdkObject][ObjectDefRef];
595
+ const where = {
596
+ [objectDef.primaryKeyApiName]: {
597
+ $in: objects.map(x => x.$primaryKey)
598
+ }
599
+ };
600
+ const result = await client(objectDef).where(where).fetchPage();
601
+ return [apiName, Object.fromEntries(result.data.map(x => [x.$primaryKey, x]))];
602
+ })));
603
+ data = data.map(obj => {
604
+ !objectTypeToPrimaryKeyToObject[obj.$objectType][obj.$primaryKey] ? process.env.NODE_ENV !== "production" ? invariant(false, `Could not find object ${obj.$objectType} ${obj.$primaryKey}`) : invariant(false) : void 0;
605
+ return objectTypeToPrimaryKeyToObject[obj.$objectType][obj.$primaryKey];
606
+ });
607
+ return data;
608
+ }
609
+ export function isListCacheKey(cacheKey) {
610
+ return cacheKey.type === "list";
611
+ }
612
+
613
+ /**
614
+ * Copied from @osdk/api
615
+ */
250
616
  //# sourceMappingURL=ListQuery.js.map