@ahoo-wang/wow-client 10.0.0-alpha.3 → 10.0.0-alpha.4

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 (420) hide show
  1. package/README.md +85 -230
  2. package/README.zh-CN.md +74 -209
  3. package/dist/commands.cjs +2 -0
  4. package/dist/commands.cjs.map +1 -0
  5. package/dist/{v10/commands.d.cts → commands.d.cts} +21 -3
  6. package/dist/{v10/commands.d.ts → commands.d.ts} +21 -3
  7. package/dist/commands.es.js +96 -0
  8. package/dist/commands.es.js.map +1 -0
  9. package/dist/dsl/aggregation/types.cjs.map +1 -1
  10. package/dist/dsl/aggregation/types.d.cts +1 -1
  11. package/dist/dsl/aggregation/types.d.ts +1 -1
  12. package/dist/dsl/aggregation/types.es.js.map +1 -1
  13. package/dist/dsl/cursorQuery.cjs.map +1 -1
  14. package/dist/dsl/cursorQuery.d.cts +7 -8
  15. package/dist/dsl/cursorQuery.d.ts +7 -8
  16. package/dist/dsl/cursorQuery.es.js.map +1 -1
  17. package/dist/dsl/descriptor.cjs.map +1 -1
  18. package/dist/dsl/descriptor.d.cts +1 -1
  19. package/dist/dsl/descriptor.d.ts +1 -1
  20. package/dist/dsl/descriptor.es.js.map +1 -1
  21. package/dist/dsl/documents.d.cts +1 -1
  22. package/dist/dsl/documents.d.ts +1 -1
  23. package/dist/dsl/filter/types.d.cts +2 -1
  24. package/dist/dsl/filter/types.d.ts +2 -1
  25. package/dist/dsl/projection.cjs.map +1 -1
  26. package/dist/dsl/projection.d.cts +22 -0
  27. package/dist/dsl/projection.d.ts +22 -0
  28. package/dist/dsl/projection.es.js.map +1 -1
  29. package/dist/dsl/queryErrorCodes.cjs +2 -0
  30. package/dist/dsl/queryErrorCodes.cjs.map +1 -0
  31. package/dist/{error → dsl}/queryErrorCodes.d.cts +25 -24
  32. package/dist/{error → dsl}/queryErrorCodes.d.ts +25 -24
  33. package/dist/{error → dsl}/queryErrorCodes.es.js +2 -1
  34. package/dist/{error/queryErrorCodes.cjs.map → dsl/queryErrorCodes.es.js.map} +1 -1
  35. package/dist/dsl.cjs +1 -1
  36. package/dist/dsl.d.cts +1 -2
  37. package/dist/dsl.d.ts +1 -2
  38. package/dist/dsl.es.js +2 -3
  39. package/dist/exactJson.cjs +3 -0
  40. package/dist/exactJson.cjs.map +1 -0
  41. package/dist/exactJson.d.cts +54 -0
  42. package/dist/exactJson.d.ts +54 -0
  43. package/dist/exactJson.es.js +213 -0
  44. package/dist/exactJson.es.js.map +1 -0
  45. package/dist/http.cjs +2 -0
  46. package/dist/http.cjs.map +1 -0
  47. package/dist/{v10/http.d.cts → http.d.cts} +16 -7
  48. package/dist/{v10/http.d.ts → http.d.ts} +16 -7
  49. package/dist/http.es.js +77 -0
  50. package/dist/http.es.js.map +1 -0
  51. package/dist/index.cjs +1 -1
  52. package/dist/index.d.cts +19 -17
  53. package/dist/index.d.ts +19 -17
  54. package/dist/index.es.js +10 -36
  55. package/dist/manifest.cjs.map +1 -0
  56. package/dist/{v10/manifest.es.js → manifest.es.js} +1 -1
  57. package/dist/manifest.es.js.map +1 -0
  58. package/dist/problem.cjs +2 -0
  59. package/dist/problem.cjs.map +1 -0
  60. package/dist/{v10/problem.d.cts → problem.d.cts} +51 -4
  61. package/dist/{v10/problem.d.ts → problem.d.ts} +51 -4
  62. package/dist/{v10/problem.es.js → problem.es.js} +30 -11
  63. package/dist/problem.es.js.map +1 -0
  64. package/dist/queries.cjs +2 -0
  65. package/dist/queries.cjs.map +1 -0
  66. package/dist/{v10/queries.d.cts → queries.d.cts} +63 -17
  67. package/dist/{v10/queries.d.ts → queries.d.ts} +63 -17
  68. package/dist/queries.es.js +112 -0
  69. package/dist/queries.es.js.map +1 -0
  70. package/dist/state.cjs +2 -0
  71. package/dist/state.cjs.map +1 -0
  72. package/dist/{v10/state.d.cts → state.d.cts} +26 -4
  73. package/dist/{v10/state.d.ts → state.d.ts} +26 -4
  74. package/dist/state.es.js +70 -0
  75. package/dist/state.es.js.map +1 -0
  76. package/dist/streams.cjs +2 -0
  77. package/dist/streams.cjs.map +1 -0
  78. package/dist/streams.d.cts +74 -0
  79. package/dist/streams.d.ts +74 -0
  80. package/dist/streams.es.js +103 -0
  81. package/dist/streams.es.js.map +1 -0
  82. package/dist/wait.cjs.map +1 -0
  83. package/dist/{v10/wait.es.js → wait.es.js} +1 -1
  84. package/dist/wait.es.js.map +1 -0
  85. package/dist/wire.cjs.map +1 -0
  86. package/dist/{v10/wire.d.cts → wire.d.cts} +32 -7
  87. package/dist/{v10/wire.d.ts → wire.d.ts} +32 -7
  88. package/dist/{v10/wire.es.js → wire.es.js} +1 -1
  89. package/dist/wire.es.js.map +1 -0
  90. package/package.json +4 -26
  91. package/dist/_virtual/_@oxc-project_runtime@0.153.0/helpers/esm/decorate.cjs +0 -1
  92. package/dist/_virtual/_@oxc-project_runtime@0.153.0/helpers/esm/decorate.es.js +0 -9
  93. package/dist/_virtual/_@oxc-project_runtime@0.153.0/helpers/esm/decorateMetadata.cjs +0 -1
  94. package/dist/_virtual/_@oxc-project_runtime@0.153.0/helpers/esm/decorateMetadata.es.js +0 -6
  95. package/dist/_virtual/_@oxc-project_runtime@0.153.0/helpers/esm/decorateParam.cjs +0 -1
  96. package/dist/_virtual/_@oxc-project_runtime@0.153.0/helpers/esm/decorateParam.es.js +0 -8
  97. package/dist/client/bindMethods.cjs +0 -2
  98. package/dist/client/bindMethods.cjs.map +0 -1
  99. package/dist/client/bindMethods.d.cts +0 -13
  100. package/dist/client/bindMethods.d.ts +0 -13
  101. package/dist/client/bindMethods.es.js +0 -19
  102. package/dist/client/bindMethods.es.js.map +0 -1
  103. package/dist/client/command/commandClient.cjs +0 -2
  104. package/dist/client/command/commandClient.cjs.map +0 -1
  105. package/dist/client/command/commandClient.d.cts +0 -67
  106. package/dist/client/command/commandClient.d.ts +0 -67
  107. package/dist/client/command/commandClient.es.js +0 -38
  108. package/dist/client/command/commandClient.es.js.map +0 -1
  109. package/dist/client/command/commandHeaders.cjs +0 -2
  110. package/dist/client/command/commandHeaders.cjs.map +0 -1
  111. package/dist/client/command/commandHeaders.d.cts +0 -75
  112. package/dist/client/command/commandHeaders.d.ts +0 -75
  113. package/dist/client/command/commandHeaders.es.js +0 -31
  114. package/dist/client/command/commandHeaders.es.js.map +0 -1
  115. package/dist/client/command/commandRequest.cjs +0 -2
  116. package/dist/client/command/commandRequest.cjs.map +0 -1
  117. package/dist/client/command/commandRequest.d.cts +0 -180
  118. package/dist/client/command/commandRequest.d.ts +0 -180
  119. package/dist/client/command/commandRequest.es.js +0 -31
  120. package/dist/client/command/commandRequest.es.js.map +0 -1
  121. package/dist/client/command/commandResult.d.cts +0 -15
  122. package/dist/client/command/commandResult.d.ts +0 -15
  123. package/dist/client/command/index.d.cts +0 -5
  124. package/dist/client/command/index.d.ts +0 -5
  125. package/dist/client/command/types.d.cts +0 -71
  126. package/dist/client/command/types.d.ts +0 -71
  127. package/dist/client/metadata/index.d.cts +0 -2
  128. package/dist/client/metadata/index.d.ts +0 -2
  129. package/dist/client/metadata/wowMetadata.d.cts +0 -48
  130. package/dist/client/metadata/wowMetadata.d.ts +0 -48
  131. package/dist/client/metadata/wowMetadataClient.cjs +0 -2
  132. package/dist/client/metadata/wowMetadataClient.cjs.map +0 -1
  133. package/dist/client/metadata/wowMetadataClient.d.cts +0 -23
  134. package/dist/client/metadata/wowMetadataClient.d.ts +0 -23
  135. package/dist/client/metadata/wowMetadataClient.es.js +0 -25
  136. package/dist/client/metadata/wowMetadataClient.es.js.map +0 -1
  137. package/dist/client/query/dataset/datasetDescriptorEndpoint.cjs +0 -2
  138. package/dist/client/query/dataset/datasetDescriptorEndpoint.cjs.map +0 -1
  139. package/dist/client/query/dataset/datasetDescriptorEndpoint.d.cts +0 -8
  140. package/dist/client/query/dataset/datasetDescriptorEndpoint.d.ts +0 -8
  141. package/dist/client/query/dataset/datasetDescriptorEndpoint.es.js +0 -34
  142. package/dist/client/query/dataset/datasetDescriptorEndpoint.es.js.map +0 -1
  143. package/dist/client/query/dataset/datasetDirectoryClient.cjs +0 -2
  144. package/dist/client/query/dataset/datasetDirectoryClient.cjs.map +0 -1
  145. package/dist/client/query/dataset/datasetDirectoryClient.d.cts +0 -29
  146. package/dist/client/query/dataset/datasetDirectoryClient.d.ts +0 -29
  147. package/dist/client/query/dataset/datasetDirectoryClient.es.js +0 -25
  148. package/dist/client/query/dataset/datasetDirectoryClient.es.js.map +0 -1
  149. package/dist/client/query/dataset/datasetQueryApi.d.cts +0 -40
  150. package/dist/client/query/dataset/datasetQueryApi.d.ts +0 -40
  151. package/dist/client/query/dataset/datasetQueryClient.cjs +0 -2
  152. package/dist/client/query/dataset/datasetQueryClient.cjs.map +0 -1
  153. package/dist/client/query/dataset/datasetQueryClient.d.cts +0 -57
  154. package/dist/client/query/dataset/datasetQueryClient.d.ts +0 -57
  155. package/dist/client/query/dataset/datasetQueryClient.es.js +0 -154
  156. package/dist/client/query/dataset/datasetQueryClient.es.js.map +0 -1
  157. package/dist/client/query/dataset/endpointPaths.cjs +0 -2
  158. package/dist/client/query/dataset/endpointPaths.cjs.map +0 -1
  159. package/dist/client/query/dataset/endpointPaths.d.cts +0 -9
  160. package/dist/client/query/dataset/endpointPaths.d.ts +0 -9
  161. package/dist/client/query/dataset/endpointPaths.es.js +0 -14
  162. package/dist/client/query/dataset/endpointPaths.es.js.map +0 -1
  163. package/dist/client/query/dataset/index.d.cts +0 -3
  164. package/dist/client/query/dataset/index.d.ts +0 -3
  165. package/dist/client/query/descriptor/descriptorEndpoints.cjs +0 -2
  166. package/dist/client/query/descriptor/descriptorEndpoints.cjs.map +0 -1
  167. package/dist/client/query/descriptor/descriptorEndpoints.d.cts +0 -29
  168. package/dist/client/query/descriptor/descriptorEndpoints.d.ts +0 -29
  169. package/dist/client/query/descriptor/descriptorEndpoints.es.js +0 -69
  170. package/dist/client/query/descriptor/descriptorEndpoints.es.js.map +0 -1
  171. package/dist/client/query/descriptor/endpointPaths.cjs +0 -2
  172. package/dist/client/query/descriptor/endpointPaths.cjs.map +0 -1
  173. package/dist/client/query/descriptor/endpointPaths.d.cts +0 -4
  174. package/dist/client/query/descriptor/endpointPaths.d.ts +0 -4
  175. package/dist/client/query/descriptor/endpointPaths.es.js +0 -9
  176. package/dist/client/query/descriptor/endpointPaths.es.js.map +0 -1
  177. package/dist/client/query/descriptor/index.d.cts +0 -2
  178. package/dist/client/query/descriptor/index.d.ts +0 -2
  179. package/dist/client/query/descriptor/queryDescriptorApi.d.cts +0 -58
  180. package/dist/client/query/descriptor/queryDescriptorApi.d.ts +0 -58
  181. package/dist/client/query/descriptor/queryDescriptorClient.cjs +0 -2
  182. package/dist/client/query/descriptor/queryDescriptorClient.cjs.map +0 -1
  183. package/dist/client/query/descriptor/queryDescriptorClient.d.cts +0 -61
  184. package/dist/client/query/descriptor/queryDescriptorClient.d.ts +0 -61
  185. package/dist/client/query/descriptor/queryDescriptorClient.es.js +0 -20
  186. package/dist/client/query/descriptor/queryDescriptorClient.es.js.map +0 -1
  187. package/dist/client/query/event/endpointPaths.cjs +0 -2
  188. package/dist/client/query/event/endpointPaths.cjs.map +0 -1
  189. package/dist/client/query/event/endpointPaths.d.cts +0 -8
  190. package/dist/client/query/event/endpointPaths.d.ts +0 -8
  191. package/dist/client/query/event/endpointPaths.es.js +0 -13
  192. package/dist/client/query/event/endpointPaths.es.js.map +0 -1
  193. package/dist/client/query/event/eventStreamQueryApi.d.cts +0 -29
  194. package/dist/client/query/event/eventStreamQueryApi.d.ts +0 -29
  195. package/dist/client/query/event/eventStreamQueryClient.cjs +0 -2
  196. package/dist/client/query/event/eventStreamQueryClient.cjs.map +0 -1
  197. package/dist/client/query/event/eventStreamQueryClient.d.cts +0 -193
  198. package/dist/client/query/event/eventStreamQueryClient.d.ts +0 -193
  199. package/dist/client/query/event/eventStreamQueryClient.es.js +0 -160
  200. package/dist/client/query/event/eventStreamQueryClient.es.js.map +0 -1
  201. package/dist/client/query/event/index.d.cts +0 -2
  202. package/dist/client/query/event/index.d.ts +0 -2
  203. package/dist/client/query/factory.cjs +0 -2
  204. package/dist/client/query/factory.cjs.map +0 -1
  205. package/dist/client/query/factory.d.cts +0 -165
  206. package/dist/client/query/factory.d.ts +0 -165
  207. package/dist/client/query/factory.es.js +0 -45
  208. package/dist/client/query/factory.es.js.map +0 -1
  209. package/dist/client/query/index.d.cts +0 -7
  210. package/dist/client/query/index.d.ts +0 -7
  211. package/dist/client/query/queryApi.d.cts +0 -68
  212. package/dist/client/query/queryApi.d.ts +0 -68
  213. package/dist/client/query/requests.d.cts +0 -24
  214. package/dist/client/query/requests.d.ts +0 -24
  215. package/dist/client/query/snapshot/endpointPaths.cjs +0 -2
  216. package/dist/client/query/snapshot/endpointPaths.cjs.map +0 -1
  217. package/dist/client/query/snapshot/endpointPaths.d.cts +0 -12
  218. package/dist/client/query/snapshot/endpointPaths.d.ts +0 -12
  219. package/dist/client/query/snapshot/endpointPaths.es.js +0 -17
  220. package/dist/client/query/snapshot/endpointPaths.es.js.map +0 -1
  221. package/dist/client/query/snapshot/index.d.cts +0 -2
  222. package/dist/client/query/snapshot/index.d.ts +0 -2
  223. package/dist/client/query/snapshot/snapshotQueryApi.d.cts +0 -101
  224. package/dist/client/query/snapshot/snapshotQueryApi.d.ts +0 -101
  225. package/dist/client/query/snapshot/snapshotQueryClient.cjs +0 -2
  226. package/dist/client/query/snapshot/snapshotQueryClient.cjs.map +0 -1
  227. package/dist/client/query/snapshot/snapshotQueryClient.d.cts +0 -372
  228. package/dist/client/query/snapshot/snapshotQueryClient.d.ts +0 -372
  229. package/dist/client/query/snapshot/snapshotQueryClient.es.js +0 -239
  230. package/dist/client/query/snapshot/snapshotQueryClient.es.js.map +0 -1
  231. package/dist/client/query/state/endpointPaths.cjs +0 -2
  232. package/dist/client/query/state/endpointPaths.cjs.map +0 -1
  233. package/dist/client/query/state/endpointPaths.d.cts +0 -10
  234. package/dist/client/query/state/endpointPaths.d.ts +0 -10
  235. package/dist/client/query/state/endpointPaths.es.js +0 -14
  236. package/dist/client/query/state/endpointPaths.es.js.map +0 -1
  237. package/dist/client/query/state/index.d.cts +0 -4
  238. package/dist/client/query/state/index.d.ts +0 -4
  239. package/dist/client/query/state/loadOwnerStateAggregateApi.d.cts +0 -36
  240. package/dist/client/query/state/loadOwnerStateAggregateApi.d.ts +0 -36
  241. package/dist/client/query/state/loadOwnerStateAggregateClient.cjs +0 -2
  242. package/dist/client/query/state/loadOwnerStateAggregateClient.cjs.map +0 -1
  243. package/dist/client/query/state/loadOwnerStateAggregateClient.d.cts +0 -58
  244. package/dist/client/query/state/loadOwnerStateAggregateClient.d.ts +0 -58
  245. package/dist/client/query/state/loadOwnerStateAggregateClient.es.js +0 -56
  246. package/dist/client/query/state/loadOwnerStateAggregateClient.es.js.map +0 -1
  247. package/dist/client/query/state/loadStateAggregateApi.d.cts +0 -37
  248. package/dist/client/query/state/loadStateAggregateApi.d.ts +0 -37
  249. package/dist/client/query/state/loadStateAggregateClient.cjs +0 -2
  250. package/dist/client/query/state/loadStateAggregateClient.cjs.map +0 -1
  251. package/dist/client/query/state/loadStateAggregateClient.d.cts +0 -62
  252. package/dist/client/query/state/loadStateAggregateClient.d.ts +0 -62
  253. package/dist/client/query/state/loadStateAggregateClient.es.js +0 -65
  254. package/dist/client/query/state/loadStateAggregateClient.es.js.map +0 -1
  255. package/dist/client/routing.cjs +0 -2
  256. package/dist/client/routing.cjs.map +0 -1
  257. package/dist/client/routing.d.cts +0 -47
  258. package/dist/client/routing.d.ts +0 -47
  259. package/dist/client/routing.es.js +0 -8
  260. package/dist/client/routing.es.js.map +0 -1
  261. package/dist/error/errorInfo.cjs +0 -2
  262. package/dist/error/errorInfo.cjs.map +0 -1
  263. package/dist/error/errorInfo.d.cts +0 -139
  264. package/dist/error/errorInfo.d.ts +0 -139
  265. package/dist/error/errorInfo.es.js +0 -32
  266. package/dist/error/errorInfo.es.js.map +0 -1
  267. package/dist/error/headers.cjs +0 -2
  268. package/dist/error/headers.cjs.map +0 -1
  269. package/dist/error/headers.d.cts +0 -39
  270. package/dist/error/headers.d.ts +0 -39
  271. package/dist/error/headers.es.js +0 -10
  272. package/dist/error/headers.es.js.map +0 -1
  273. package/dist/error/index.d.cts +0 -21
  274. package/dist/error/index.d.ts +0 -21
  275. package/dist/error/queryErrorCodes.cjs +0 -2
  276. package/dist/error/queryErrorCodes.es.js.map +0 -1
  277. package/dist/error/wowError.cjs +0 -2
  278. package/dist/error/wowError.cjs.map +0 -1
  279. package/dist/error/wowError.d.cts +0 -99
  280. package/dist/error/wowError.d.ts +0 -99
  281. package/dist/error/wowError.es.js +0 -53
  282. package/dist/error/wowError.es.js.map +0 -1
  283. package/dist/legacy/condition.cjs +0 -2
  284. package/dist/legacy/condition.cjs.map +0 -1
  285. package/dist/legacy/condition.d.cts +0 -517
  286. package/dist/legacy/condition.d.ts +0 -517
  287. package/dist/legacy/condition.es.js +0 -338
  288. package/dist/legacy/condition.es.js.map +0 -1
  289. package/dist/legacy/index.d.cts +0 -16
  290. package/dist/legacy/index.d.ts +0 -16
  291. package/dist/legacy/locale/en_US.cjs +0 -2
  292. package/dist/legacy/locale/en_US.cjs.map +0 -1
  293. package/dist/legacy/locale/en_US.d.cts +0 -7
  294. package/dist/legacy/locale/en_US.d.ts +0 -7
  295. package/dist/legacy/locale/en_US.es.js +0 -50
  296. package/dist/legacy/locale/en_US.es.js.map +0 -1
  297. package/dist/legacy/locale/operatorLocale.d.cts +0 -10
  298. package/dist/legacy/locale/operatorLocale.d.ts +0 -10
  299. package/dist/legacy/locale/zh_CN.cjs +0 -2
  300. package/dist/legacy/locale/zh_CN.cjs.map +0 -1
  301. package/dist/legacy/locale/zh_CN.d.cts +0 -7
  302. package/dist/legacy/locale/zh_CN.d.ts +0 -7
  303. package/dist/legacy/locale/zh_CN.es.js +0 -50
  304. package/dist/legacy/locale/zh_CN.es.js.map +0 -1
  305. package/dist/legacy/operator.cjs +0 -2
  306. package/dist/legacy/operator.cjs.map +0 -1
  307. package/dist/legacy/operator.d.cts +0 -218
  308. package/dist/legacy/operator.d.ts +0 -218
  309. package/dist/legacy/operator.es.js +0 -25
  310. package/dist/legacy/operator.es.js.map +0 -1
  311. package/dist/legacy/queryable.cjs +0 -2
  312. package/dist/legacy/queryable.cjs.map +0 -1
  313. package/dist/legacy/queryable.d.cts +0 -61
  314. package/dist/legacy/queryable.d.ts +0 -61
  315. package/dist/legacy/queryable.es.js +0 -34
  316. package/dist/legacy/queryable.es.js.map +0 -1
  317. package/dist/legacy.cjs +0 -1
  318. package/dist/legacy.es.js +0 -6
  319. package/dist/model/abac.cjs +0 -2
  320. package/dist/model/abac.cjs.map +0 -1
  321. package/dist/model/abac.d.cts +0 -33
  322. package/dist/model/abac.d.ts +0 -33
  323. package/dist/model/abac.es.js +0 -6
  324. package/dist/model/abac.es.js.map +0 -1
  325. package/dist/model/bi.cjs +0 -2
  326. package/dist/model/bi.cjs.map +0 -1
  327. package/dist/model/bi.d.cts +0 -12
  328. package/dist/model/bi.d.ts +0 -12
  329. package/dist/model/bi.es.js +0 -8
  330. package/dist/model/bi.es.js.map +0 -1
  331. package/dist/model/command.cjs +0 -2
  332. package/dist/model/command.cjs.map +0 -1
  333. package/dist/model/command.d.cts +0 -137
  334. package/dist/model/command.d.ts +0 -137
  335. package/dist/model/command.es.js +0 -8
  336. package/dist/model/command.es.js.map +0 -1
  337. package/dist/model/common.d.cts +0 -19
  338. package/dist/model/common.d.ts +0 -19
  339. package/dist/model/domainEventStream.cjs +0 -2
  340. package/dist/model/domainEventStream.cjs.map +0 -1
  341. package/dist/model/domainEventStream.d.cts +0 -109
  342. package/dist/model/domainEventStream.d.ts +0 -109
  343. package/dist/model/domainEventStream.es.js +0 -23
  344. package/dist/model/domainEventStream.es.js.map +0 -1
  345. package/dist/model/function.cjs +0 -2
  346. package/dist/model/function.cjs.map +0 -1
  347. package/dist/model/function.d.cts +0 -41
  348. package/dist/model/function.d.ts +0 -41
  349. package/dist/model/function.es.js +0 -8
  350. package/dist/model/function.es.js.map +0 -1
  351. package/dist/model/index.d.cts +0 -24
  352. package/dist/model/index.d.ts +0 -24
  353. package/dist/model/messaging.d.cts +0 -5
  354. package/dist/model/messaging.d.ts +0 -5
  355. package/dist/model/modeling.d.cts +0 -145
  356. package/dist/model/modeling.d.ts +0 -145
  357. package/dist/model/naming.d.cts +0 -27
  358. package/dist/model/naming.d.ts +0 -27
  359. package/dist/model/snapshot.cjs +0 -2
  360. package/dist/model/snapshot.cjs.map +0 -1
  361. package/dist/model/snapshot.d.cts +0 -53
  362. package/dist/model/snapshot.d.ts +0 -53
  363. package/dist/model/snapshot.es.js +0 -20
  364. package/dist/model/snapshot.es.js.map +0 -1
  365. package/dist/transport/endpoints.cjs +0 -2
  366. package/dist/transport/endpoints.cjs.map +0 -1
  367. package/dist/transport/endpoints.d.cts +0 -79
  368. package/dist/transport/endpoints.d.ts +0 -79
  369. package/dist/transport/endpoints.es.js +0 -14
  370. package/dist/transport/endpoints.es.js.map +0 -1
  371. package/dist/transport/eventStreams.cjs +0 -2
  372. package/dist/transport/eventStreams.cjs.map +0 -1
  373. package/dist/transport/eventStreams.d.cts +0 -25
  374. package/dist/transport/eventStreams.d.ts +0 -25
  375. package/dist/transport/eventStreams.es.js +0 -21
  376. package/dist/transport/eventStreams.es.js.map +0 -1
  377. package/dist/transport/index.d.cts +0 -1
  378. package/dist/transport/index.d.ts +0 -1
  379. package/dist/v10/commands.cjs +0 -2
  380. package/dist/v10/commands.cjs.map +0 -1
  381. package/dist/v10/commands.es.js +0 -68
  382. package/dist/v10/commands.es.js.map +0 -1
  383. package/dist/v10/http.cjs +0 -2
  384. package/dist/v10/http.cjs.map +0 -1
  385. package/dist/v10/http.es.js +0 -73
  386. package/dist/v10/http.es.js.map +0 -1
  387. package/dist/v10/index.d.cts +0 -19
  388. package/dist/v10/index.d.ts +0 -19
  389. package/dist/v10/manifest.cjs.map +0 -1
  390. package/dist/v10/manifest.es.js.map +0 -1
  391. package/dist/v10/problem.cjs +0 -2
  392. package/dist/v10/problem.cjs.map +0 -1
  393. package/dist/v10/problem.es.js.map +0 -1
  394. package/dist/v10/queries.cjs +0 -2
  395. package/dist/v10/queries.cjs.map +0 -1
  396. package/dist/v10/queries.es.js +0 -88
  397. package/dist/v10/queries.es.js.map +0 -1
  398. package/dist/v10/state.cjs +0 -2
  399. package/dist/v10/state.cjs.map +0 -1
  400. package/dist/v10/state.es.js +0 -51
  401. package/dist/v10/state.es.js.map +0 -1
  402. package/dist/v10/streams.cjs +0 -2
  403. package/dist/v10/streams.cjs.map +0 -1
  404. package/dist/v10/streams.d.cts +0 -14
  405. package/dist/v10/streams.d.ts +0 -14
  406. package/dist/v10/streams.es.js +0 -22
  407. package/dist/v10/streams.es.js.map +0 -1
  408. package/dist/v10/wait.cjs.map +0 -1
  409. package/dist/v10/wait.es.js.map +0 -1
  410. package/dist/v10/wire.cjs.map +0 -1
  411. package/dist/v10/wire.es.js.map +0 -1
  412. package/dist/v10.cjs +0 -1
  413. package/dist/v10.es.js +0 -9
  414. /package/dist/{v10/manifest.cjs → manifest.cjs} +0 -0
  415. /package/dist/{v10/manifest.d.cts → manifest.d.cts} +0 -0
  416. /package/dist/{v10/manifest.d.ts → manifest.d.ts} +0 -0
  417. /package/dist/{v10/wait.cjs → wait.cjs} +0 -0
  418. /package/dist/{v10/wait.d.cts → wait.d.cts} +0 -0
  419. /package/dist/{v10/wait.d.ts → wait.d.ts} +0 -0
  420. /package/dist/{v10/wire.cjs → wire.cjs} +0 -0
package/README.zh-CN.md CHANGED
@@ -1,114 +1,70 @@
1
1
  # `@ahoo-wang/wow-client`
2
2
 
3
- 面向 Wow 命令、快照、领域事件、过滤、分页与聚合的类型化 Fetcher 客户端和契约。只在
4
- 对接 Wow HTTP 端点时使用。
3
+ Wow 服务路由的 TypeScript 客户端,构建在 Fetcher 之上:命令及其等待、状态读取、快照
4
+ 查询、事件查询与数据集查询、Manifest,以及服务应答的 RFC 9457 问题(problem)。查询
5
+ DSL(`filter`、`aggregation`、排序、投影、分页)在单独的入口
6
+ `@ahoo-wang/wow-client/dsl`。
5
7
 
6
- 支持的服务端:Wow 8.11 及以后通过 `filter` API;Wow 8.10 通过
7
- [`/legacy`](#wow-810-服务端ahoo-wangwow-clientlegacy)。CI 用同版本的服务端测试
8
- 客户端,并对 Wow 8.11.5、9.1.3、9.1.5 做运行时冒烟测试;对 8.10.8 只检查生成代码的类型。
9
- Node `>=22.12.0` 或现代浏览器。TypeScript 6 或更高版本:CI 测试 6.0 到最新的 7.x。详见
10
- [兼容性矩阵](https://wow.ahoo.me/zh/guide/typescript/compatibility)。
11
-
12
- 随 Wow 9.2.0 发布,与 Wow 同一个 tag、同一个版本号。
8
+ Node `>=22.12.0` 或现代浏览器。TypeScript 6 或更高版本:CI 测试 6.0 到最新的 7.x。
9
+ 随 Wow 发布,与 Wow 同一个 tag、同一个版本号。
13
10
 
14
11
  ## 安装
15
12
 
16
13
  ```bash
17
- pnpm add @ahoo-wang/fetcher @ahoo-wang/fetcher-decorator \
18
- @ahoo-wang/fetcher-eventstream @ahoo-wang/wow-client
14
+ pnpm add @ahoo-wang/fetcher @ahoo-wang/fetcher-eventstream @ahoo-wang/wow-client
19
15
  ```
20
16
 
21
- 版本号跟随 Wow,次版本可能带有破坏性改动:用 `save-prefix=~` 或 `--save-exact` 让 Wow 包停在同一个次版本上,见[版本范围](https://wow.ahoo.me/zh/guide/typescript/compatibility#版本范围)。
17
+ 版本号跟随 Wow,次版本可能带有破坏性改动:用 `save-prefix=~` 或 `--save-exact` 让 Wow 包停在同一个次版本上,见[版本范围](https://wow.ahoo.me/zh/typescript/compatibility#版本范围)。
18
+
19
+ Peer 依赖:`@ahoo-wang/fetcher` 和 `@ahoo-wang/fetcher-eventstream`。
22
20
 
23
- Peer 依赖:`fetcher`、`fetcher-decorator` 和 `fetcher-eventstream`。
21
+ 多数应用用 `wow-generator` 按服务的 Manifest 生成的客户端,它们建在下面这些类之上;
22
+ 每个类也能手工调用任意路由。
24
23
 
25
24
  ## 查询
26
25
 
26
+ 聚合的快照在 `/{context}/{aggregate}/snapshot/query` 上查询,请求体用 `kind` 说明
27
+ 操作,由客户端填写。
28
+
27
29
  ```ts
28
30
  import { Fetcher } from '@ahoo-wang/fetcher';
29
- import { SnapshotQueryClient, filter, listQuery } from '@ahoo-wang/wow-client';
31
+ import { SnapshotQueryClient } from '@ahoo-wang/wow-client';
32
+ import { filter, listQuery } from '@ahoo-wang/wow-client/dsl';
30
33
 
31
34
  interface CartState {
32
35
  status: 'ACTIVE' | 'CHECKED_OUT';
33
36
  }
34
37
 
35
38
  const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
36
- const snapshots = new SnapshotQueryClient<CartState>({
37
- fetcher,
38
- basePath: 'cart',
39
- });
40
-
41
- const carts = await snapshots.listState(
42
- listQuery({
43
- filter: filter.and([
44
- filter.ownerId('u-42'),
45
- filter.eq('state.status', 'ACTIVE'),
46
- ]),
47
- limit: 50,
48
- }),
39
+ const carts = new SnapshotQueryClient<CartState>(
40
+ { context: 'shop', name: 'cart' },
41
+ { fetcher },
42
+ );
43
+
44
+ const active = await carts.list(
45
+ listQuery({ filter: filter.eq('state.status', 'ACTIVE'), limit: 50 }),
49
46
  );
50
47
  ```
51
48
 
52
- `listQuery()`、`pagedQuery()`、`singleQuery()` 不传过滤条件时匹配全部。`listQuery()`
53
- 只在给出 `limit` 时才发送它;不带 `limit` 时服务端怎么做,取决于它的版本:
49
+ `single`、`list`、`paged`、`cursor`、`count`、`aggregate` 各对应一种操作;
50
+ `listStream` 以服务端推送事件读列表,服务中断的流从中断处续读。`describe(version?)`
51
+ 读查询模型的能力描述(同一路由的 `GET`):每个字段可用的运算符、排序与聚合,以及
52
+ 各项上限;传入已持有的版本,304 时返回 `{ notModified: true, version }`。
53
+ `EventQueryClient` 以同样方式查询聚合的事件流,`QueryModelClient` 查询任意查询路由,
54
+ `DatasetClient` 列出服务的数据集(`GET /wow/dataset`)。
54
55
 
55
- - Wow 9.1.5 及以后:用服务端的默认列表大小(未另行配置时为 100)。
56
- - Wow 8.11~9.1.3:以 `IllegalArgument` 拒绝,信息里有
57
- `limit[0] must be between 1 and 1000`;列表是 HTTP 400,列表流以这个错误事件结束。对这些服务端请显式传 `limit`;
58
- 这次拒绝得到的 `WowError` 也会这样提示。
56
+ 每个方法最后一个参数是 `RequestOptions`:要在其中操作的 `scope` 和 `space`、附加的
57
+ `headers`,以及取消请求的 `signal`。
59
58
 
60
- 相对时间由服务端求值,不用浏览器的时钟。`filter.beforeNow` 与 `filter.afterNow`
61
- 把时间字段与服务端的「现在 + ISO-8601 `offset`」做严格比较(默认 `PT0S`,负值表示回看),
62
- 每个查询只取一次时钟,所以保存的视图在每个客户端上含义相同:
59
+ 相对时间由服务端解析,从不用浏览器的时钟:
63
60
 
64
61
  ```ts
65
- import { filter } from '@ahoo-wang/wow-client';
62
+ import { filter } from '@ahoo-wang/wow-client/dsl';
66
63
 
67
64
  const overdue = filter.beforeNow('state.timeoutAt');
68
65
  const lastHalfHour = filter.afterNow('state.createTime', '-PT30M');
69
66
  ```
70
67
 
71
- `BEFORE_NOW` 与 `AFTER_NOW` 需要 Wow 9.2.0 及以上;更早的服务端会拒绝该查询。
72
-
73
- ## 服务端能查什么:能力描述
74
-
75
- `QueryDescriptorClient` 读取 `GET {aggregate}/snapshot/schema` 与
76
- `GET {aggregate}/event/schema`(Wow 9.2.0 及以上):一份 `QueryModelDescriptor`,
77
- 列出每个可查询字段允许的过滤算子、排序与聚合,哪些指标是估算值、日期直方图可用哪些单位、按日期部分分组可用哪些部分、日期差可用哪些单位、`FIRST` 与 `LAST` 未指定时按哪个字段排序,
78
- 以及分页方式、全文检索(记录上的,以及存储支持时元素内的)和该入口的上限。
79
- 它列出的每项能力单独使用都会被接受,没列出的都会被拒绝。用它只提供服务端接受的选项,
80
- 不必把算子表和上限写死。
81
-
82
- <!-- typecheck-context
83
- import type { Fetcher } from '@ahoo-wang/fetcher';
84
- declare const fetcher: Fetcher;
85
- -->
86
-
87
- ```ts
88
- import { FilterOperator, QueryDescriptorClient } from '@ahoo-wang/wow-client';
89
-
90
- // schema 路由没有租户、所有者段。
91
- const descriptors = new QueryDescriptorClient({ fetcher, basePath: 'cart' });
92
-
93
- const first = await descriptors.describeSnapshot();
94
- if (!first.notModified) {
95
- const productId = first.descriptor.fields.find(
96
- field => field.path === 'state.items.productId',
97
- );
98
- const canSearchByPrefix = productId?.filter.operators.includes(
99
- FilterOperator.STARTS_WITH,
100
- );
101
- }
102
-
103
- // 重新验证手上的副本:304 时得到 { notModified: true, version }。
104
- const again = await descriptors.describeSnapshot(first.version);
105
- ```
106
-
107
- 描述与调用者无关,`version` 同时是 ETag。持有它,下次把版本(或 ETag)传回:
108
- 方法会发送 `If-None-Match`,服务端答 304 时得到 `{ notModified: true, version }`。
109
- `QueryClientFactory.createQueryDescriptorClient()` 拼基础路径时不带工厂的资源归属。
110
- 服务端每隔几分钟重新加载 schema,所以长时间打开的页面应当重新验证,而不是永久缓存。
111
-
112
68
  ## 发送命令
113
69
 
114
70
  <!-- typecheck-context
@@ -117,151 +73,60 @@ declare const fetcher: Fetcher;
117
73
  -->
118
74
 
119
75
  ```ts
120
- import {
121
- CommandClient,
122
- CommandStage,
123
- commandHeaders,
124
- waitStrategy,
125
- } from '@ahoo-wang/wow-client';
126
-
127
- const commands = new CommandClient({ fetcher, basePath: 'cart' });
128
- const result = await commands.send({
129
- path: 'add_cart_item',
130
- method: 'POST',
131
- headers: {
132
- ...commandHeaders({ ownerId: 'u-42', requestId: crypto.randomUUID() }),
133
- ...waitStrategy({ stage: CommandStage.SNAPSHOT, timeoutMs: 10_000 }),
134
- },
135
- body: { productId: 'p-1', quantity: 1 },
136
- });
137
- ```
138
-
139
- `CommandRequestHeaders` 按服务端的解析方式给每个命令头定类型:等待阶段必须是
140
- `CommandStage`,超时是整数毫秒。`waitStrategy()` 也能构建 Wow 的等待链
141
- (`SAGA_HANDLED` 加 `tail`)。`sendAndWaitStream()` 在命令每到达一个阶段时产出一个
142
- `CommandResult`。
143
-
144
- ## 错误
145
-
146
- 服务端返回的错误是 `WowError`,带着服务端的 `ErrorInfo`(`errorCode`、`errorMsg`、
147
- `bindingErrors`)和 HTTP 状态码。用 `ErrorCodes` 比较 `errorCode`。Wow 以 HTTP 错误
148
- 状态应答被拒绝的请求,包括命令处理函数失败的命令,所以调用会拒绝(reject)。
149
-
150
- ```ts
151
- import {
152
- ErrorCodes,
153
- toWowError,
154
- type SnapshotQueryClient,
155
- } from '@ahoo-wang/wow-client';
156
-
157
- async function findCart(snapshots: SnapshotQueryClient<unknown>, id: string) {
158
- try {
159
- return await snapshots.getStateById(id);
160
- } catch (error) {
161
- const wowError = await toWowError(error);
162
- if (wowError?.errorCode === ErrorCodes.NOT_FOUND) return undefined;
163
- throw wowError ?? error;
164
- }
165
- }
166
- ```
167
-
168
- - 请求失败时抛出的是 fetcher 的错误。`toWowError()` 读取响应体里的 `ErrorInfo`,
169
- 读不到时读 `Wow-Error-Code` 响应头;不是 Wow 服务端的应答(网络故障、超时、取消、
170
- 代理自己的错误页)时返回 `undefined`。
171
- - 流(`listStream`、`aggregateStream`、`sendAndWaitStream` 等)中途失败时,流以
172
- `WowError` 结束,`for await` 会抛出它。服务端此时的 HTTP 状态仍是 200,错误作为
173
- 最后一个事件发出;不这样处理的话,错误会被当成一行数据。
174
- - 被拒绝的查询(解码阶段为 `IllegalArgument`,准入阶段为 `QuerySchemaValidation`)
175
- 会说明违反了哪条规则、在哪里:`wowError.violation` 为 `{ code, path, message }`,
176
- `code` 取自 `QueryErrorCodes`,`path` 是 JSON 路径(`filter.state`)或逻辑字段
177
- (`state.items.sku`)。码的列表只增不改,未处理的码回退到 `errorMsg`。从 Wow 9.2
178
- 起,预算与闸门类拒绝也带码(`SIZE_OUT_OF_RANGE`、`EXPENSIVE_OPERATOR_DISABLED` 等);更早的
179
- 服务端只给文字(`HTTP list query limit[...]`)。服务端自身的故障应答 HTTP 500
180
- `InternalServerError`,不带码。
181
-
182
- <!-- typecheck-context
183
- import type { WowError } from '@ahoo-wang/wow-client';
184
- declare const wowError: WowError;
185
- declare function markField(path: string, message: string): void;
186
- -->
187
-
188
- ```ts
189
- import { QueryErrorCodes } from '@ahoo-wang/wow-client';
190
-
191
- const violation = wowError.violation;
192
- if (violation?.code === QueryErrorCodes.UNKNOWN_FIELD) {
193
- markField(violation.path, violation.message);
194
- }
195
- ```
196
-
197
- ## 取消
198
-
199
- 每个查询方法的最后一个参数(在拦截器属性之后)接受 `AbortController` 或
200
- `AbortSignal`:
76
+ import { CommandGateway, wait } from '@ahoo-wang/wow-client';
201
77
 
202
- <!-- typecheck-context
203
- import type { FilterPagedQuery, SnapshotQueryClient } from '@ahoo-wang/wow-client';
204
- declare const snapshots: SnapshotQueryClient<unknown>;
205
- declare const query: FilterPagedQuery;
206
- -->
207
-
208
- ```ts
209
- const page = await snapshots.pagedState(
210
- query,
211
- undefined,
212
- AbortSignal.timeout(5_000),
78
+ const commands = new CommandGateway({ fetcher });
79
+ const result = await commands.send(
80
+ '/shop/cart/{id}/add-cart-item',
81
+ { productId: 'p-1', quantity: 1 },
82
+ { id: 'cart-42', wait: { plan: [wait.snapshot()], timeout: 10_000 } },
213
83
  );
214
84
  ```
215
85
 
216
- ## 不带 HTTP 的查询构建:`@ahoo-wang/wow-client/dsl`
217
-
218
- `filter`、`aggregation`、排序、投影、分页、游标查询、查询工厂和能力描述的类型,不带客户端:不加载
219
- Fetcher、装饰器、`reflect-metadata`,也不装 `fetcher-eventstream` 的全局流补丁。
220
- 只构建查询的包从这里导入。
86
+ 路由是 `POST /{context}/{aggregate}/{id}/{command}`;可以创建聚合的命令不带 `{id}`。
87
+ `wait` 说明命令走到哪一步才应答(`accepted`、`committed`、`snapshot`,或某个订阅的
88
+ `handled`,也可以跨过 Saga 派生的命令);`stream` 每到一跳应答一个 `CommandResult`。
89
+ 每条命令都带请求 id(`Wow-Request-Id`),传入的或生成的:用同一个 id 重试,应答的是
90
+ 第一次提交的重复结果;`requestIdOf(error)` 取回失败请求所用的 id。`lifecycle` 发送
91
+ 聚合列出的生命周期命令(删除、恢复、转移、标签)。
221
92
 
222
- ## Wow 8.10 服务端:`@ahoo-wang/wow-client/legacy`
93
+ `StateClient` 按版本或时间读取聚合的状态及其轨迹;`fetchManifest` 读取服务的
94
+ Manifest(`GET /wow/manifest`)。
223
95
 
224
- 根入口只使用 `FilterExpression`,Wow 8.11 及以后的服务端都支持。Wow 8.10 只认
225
- 已弃用的 Condition 模型,本包把它放在单独的子路径里,保留到 v10:
96
+ ## 错误
226
97
 
227
- <!-- typecheck-context
228
- import type { SnapshotQueryClient } from '@ahoo-wang/wow-client';
229
- declare const snapshots: SnapshotQueryClient<unknown>;
230
- -->
98
+ 服务以 RFC 9457 问题拒绝请求,调用以 `WowProblemError` 拒绝:原样的 `problem`、
99
+ `status`、Wow 的 `code` 和 `violations`。未成功的命令还带着它的 `CommandResult`,
100
+ `resolveRejected: true` 时改为返回该结果。中途失败的流以同一个错误结束,`for await`
101
+ 会抛出它。
231
102
 
232
103
  ```ts
233
- import { and, eq, listQuery, ownerId } from '@ahoo-wang/wow-client/legacy';
234
-
235
- const carts = await snapshots.listState(
236
- listQuery({ condition: and(ownerId('u-42'), eq('state.status', 'ACTIVE')) }),
237
- );
104
+ import { FrameworkErrorCodes, WowProblemError } from '@ahoo-wang/wow-client';
105
+
106
+ declare const error: unknown;
107
+ if (
108
+ error instanceof WowProblemError &&
109
+ error.code === FrameworkErrorCodes.AGGREGATE_NOT_FOUND
110
+ ) {
111
+ // …
112
+ }
238
113
  ```
239
114
 
240
- 查询客户端两种查询都接受,其余一切都从根入口导入。这个子路径在 v10 删除。
241
-
242
- ## 核心能力
115
+ 被拒绝的查询在每条 violation 里说明违反的规则:`code` 是 `QueryErrorCodes`(来自
116
+ `/dsl`)之一,`path` 是 JSON 路径或字段,还有 `message`。代码只增不减,没处理的代码
117
+ 回退到问题的 `detail`。错误的 `retry` 说明请求能否重试、何时重试、是否沿用同一个
118
+ 请求 id。
243
119
 
244
- - 命令结果与流式等待阶段。
245
- - 快照、领域事件、状态加载与所有者状态客户端;按版本区间加载事件流
246
- (`EventStreamQueryClient.load`);服务端元数据(`WowMetadataClient`);
247
- 支持条件请求的查询能力描述(`QueryDescriptorClient`)。
248
- - 提前校验的数组优先 `FilterExpression` 构建器。
249
- - 单条、列表、分页、游标、计数与流查询契约。
250
- - 投影、排序、嵌套聚合、建模、ABAC 与元数据类型。
251
- - `aggregation.query()` 按 Wow 服务端同样的规则校验整个聚合查询,
252
- 让错误在构建处暴露,而不是等到请求被拒。
120
+ ## 不带 HTTP 构建查询:`@ahoo-wang/wow-client/dsl`
253
121
 
254
- 暂时没有客户端的:`GET {id}/snapshot`、`GET {id}/state/tracing`,以及
255
- `/wow/command/send` 路由(用 `CommandClient` 加上 `COMMAND_AGGREGATE_CONTEXT`、
256
- `COMMAND_AGGREGATE_NAME`、`COMMAND_TYPE` 三个头发送)。
122
+ `filter`、`aggregation`、排序、投影、分页、游标查询、查询工厂、能力描述的类型和
123
+ `QueryErrorCodes`,不含客户端:没有 Fetcher,也没有 `fetcher-eventstream` 安装的流
124
+ 补丁。只构建查询的包用它。`aggregation.query()` 按 Wow 收到聚合时执行的规则校验整个
125
+ 聚合,错误的查询在构建处就失败。
257
126
 
258
127
  ## 文档
259
128
 
260
- - [快速开始:调用 Wow 服务](https://wow.ahoo.me/zh/guide/typescript/quick-start)
261
- - [错误处理](https://wow.ahoo.me/zh/guide/typescript/error-handling)与
262
- [认证](https://wow.ahoo.me/zh/guide/typescript/authentication)
263
- - [TypeScript 指南](https://wow.ahoo.me/zh/guide/typescript/)
264
- - [wow-client 参考](https://wow.ahoo.me/zh/reference/typescript/wow-client/)
265
- - [交互式查询 Story](https://wow.ahoo.me/storybook/)
129
+ - [TypeScript 指南](https://wow.ahoo.me/zh/typescript/)
130
+ - [交互式查询示例](https://wow.ahoo.me/storybook/)
266
131
 
267
- [English](./README.md) · [许可证](https://github.com/Ahoo-Wang/Wow/blob/main/LICENSE)
132
+ [English](./README.md) · [License](https://github.com/Ahoo-Wang/Wow/blob/main/LICENSE)
@@ -0,0 +1,2 @@
1
+ const e=require("./problem.cjs"),t=require("./http.cjs"),n=require("./streams.cjs"),r=require("./wait.cjs");var i={DELETE_AGGREGATE:`wow.lifecycle.DeleteAggregate`,RESTORE_AGGREGATE:`wow.lifecycle.RestoreAggregate`,TRANSFER_OWNER:`wow.lifecycle.TransferOwner`,TRANSFER_SPACE:`wow.lifecycle.TransferSpace`,APPLY_TAGS:`wow.lifecycle.ApplyTags`};function a(e){return e.replace(/([A-Z]+)([A-Z][a-z])/g,`$1-$2`).replace(/([a-z0-9])([A-Z])/g,`$1-$2`).replace(/[_\s]+/g,`-`).toLowerCase()}function o(){let e=globalThis.crypto;if(typeof e?.randomUUID==`function`)return e.randomUUID();let t=new Uint8Array(16);if(typeof e?.getRandomValues==`function`)e.getRandomValues(t);else for(let e=0;e<t.length;e++)t[e]=Math.floor(Math.random()*256);t[6]=t[6]&15|64,t[8]=t[8]&63|128;let n=Array.from(t,e=>e.toString(16).padStart(2,`0`));return[n.slice(0,4),n.slice(4,6),n.slice(6,8),n.slice(8,10),n.slice(10,16)].map(e=>e.join(``)).join(`-`)}async function s(t,n){try{return await n()}catch(n){throw e.rememberRequestId(n,t),n}}function c(e,n,i){let a=e.wait;return{[t.WowHeaders.REQUEST_ID]:n,[t.WowHeaders.WAIT]:a?.plan===void 0?void 0:r.formatWaitPlan(a.plan),[t.WowHeaders.WAIT_TIMEOUT]:a?.timeout===void 0?void 0:r.formatWaitTimeout(a.timeout),[t.WowHeaders.IF_MATCH]:e.expectedVersion===void 0?void 0:`"${e.expectedVersion}"`,Accept:i}}var l=class{constructor(e={}){this.client=e}async send(n,r,i={}){let a=i.requestId??o();try{return await s(a,async()=>t.json(await this.post(n,r,i,a)))}catch(t){if(i.resolveRejected&&t instanceof e.WowProblemError&&t.result!==void 0)return t.result;throw t}}async stream(e,t,r={}){let i=r.requestId??o();return s(i,async()=>n.commandResults(await this.post(e,t,r,i,`text/event-stream`)))}async lifecycle(e,n,r,l,u={}){let d=`${e}/${encodeURIComponent(n)}`;if(r===i.DELETE_AGGREGATE){let e=u.requestId??o();return s(e,async()=>{let n=await t.send(this.client,{method:`DELETE`,path:d,headers:c(u,e),options:u});return t.json(n)})}return this.send(`${d}/${a(r)}`,l??{},u)}post(e,n,r,i,a){return t.send(this.client,{method:`POST`,path:e.includes(`{id}`)?t.expandPath(e,{id:r.id??``}):e,headers:c(r,i,a),body:n??{},...r.bodyNumbers===void 0?{}:{bodyNumbers:r.bodyNumbers},options:r})}};exports.CommandGateway=l,exports.LifecycleCommands=i,exports.commandSegment=a,exports.newRequestId=o;
2
+ //# sourceMappingURL=commands.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.cjs","names":["WowHeaders","formatWaitPlan","formatWaitTimeout","json","WowProblemError","commandResults","send","expandPath","require_problem","require_http","require_streams","require_wait","LifecycleCommands","commandSegment","name","newRequestId","crypto","bytes","index","hex","byte","group","withRequestId","sending","error","requestId","commandHeaders","wait","options","accept","CommandGateway","client","path","body","base","aggregatePath","id","command","response"],"sources":["../src/commands.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { TextNumbers } from './exactJson.js';\nimport {\n expandPath,\n json,\n type RequestOptions,\n send,\n type WowClientOptions,\n WowHeaders,\n} from './http.js';\nimport type { CommandResult } from './wire.js';\nimport { rememberRequestId, WowProblemError } from './problem.js';\nimport { commandResults, type CommandResultStream } from './streams.js';\nimport { formatWaitPlan, formatWaitTimeout, type WaitOptions } from './wait.js';\n\n/** What a command request carries beside its body (decisions D95–D99). */\nexport interface CommandOptions extends RequestOptions {\n /**\n * The request id (`Wow-Request-Id`): a retry with the same one is\n * deduplicated, answered as the first commit's duplicate. When absent, the\n * gateway generates one ({@link newRequestId}), which a failure carries\n * ({@link requestIdOf}): retry with it, not with a new one.\n */\n readonly requestId?: string;\n /** What to wait for, and for how long. */\n readonly wait?: WaitOptions;\n /** The version the aggregate must be at (`If-Match`). */\n readonly expectedVersion?: number;\n /**\n * The body's numbers written as their exact text, unquoted JSON numbers\n * (review R4-Q, Q-9; decision D122): a generated client sets it for a\n * command with `int64`, `bigint` or `decimal` fields, which it types as\n * `string`.\n */\n readonly bodyNumbers?: TextNumbers;\n /**\n * Resolve a result that did not succeed instead of rejecting with its\n * {@link WowProblemError}; `false` by default.\n */\n readonly resolveRejected?: boolean;\n}\n\n/** The options of a command whose route may name the aggregate id or not. */\nexport interface CreateCommandOptions extends CommandOptions {\n /**\n * The id of the aggregate to create (decision D176); the service generates\n * one when absent.\n */\n readonly id?: string;\n}\n\n/** The lifecycle commands an aggregate may list (decision D113). */\nexport const LifecycleCommands = {\n DELETE_AGGREGATE: 'wow.lifecycle.DeleteAggregate',\n RESTORE_AGGREGATE: 'wow.lifecycle.RestoreAggregate',\n TRANSFER_OWNER: 'wow.lifecycle.TransferOwner',\n TRANSFER_SPACE: 'wow.lifecycle.TransferSpace',\n APPLY_TAGS: 'wow.lifecycle.ApplyTags',\n} as const;\n\n/** A {@link LifecycleCommands} value. */\nexport type LifecycleCommand =\n (typeof LifecycleCommands)[keyof typeof LifecycleCommands];\n\n/** The body of `wow.lifecycle.TransferOwner`. */\nexport interface TransferOwner {\n readonly ownerId: string;\n}\n\n/** The body of `wow.lifecycle.TransferSpace`. */\nexport interface TransferSpace {\n readonly spaceId: string;\n}\n\n/** The body of `wow.lifecycle.ApplyTags`: the tags, names to values. */\nexport interface ApplyTags {\n readonly tags: Readonly<Record<string, readonly string[]>>;\n}\n\n/**\n * The route segment of a command name, as the server derives it: kebab case,\n * dots kept (`AddCartItem` → `add-cart-item`,\n * `wow.lifecycle.RestoreAggregate` → `wow.lifecycle.restore-aggregate`).\n *\n * @param name - The command's name\n */\nexport function commandSegment(name: string): string {\n return name\n .replace(/([A-Z]+)([A-Z][a-z])/g, '$1-$2')\n .replace(/([a-z0-9])([A-Z])/g, '$1-$2')\n .replace(/[_\\s]+/g, '-')\n .toLowerCase();\n}\n\n/**\n * A new request id (`Wow-Request-Id`): a random UUID. The gateway generates\n * one for a command sent without; generate it first to retry with it however\n * the request fails.\n */\nexport function newRequestId(): string {\n const crypto = globalThis.crypto;\n if (typeof crypto?.randomUUID === 'function') return crypto.randomUUID();\n // An insecure browser context has no randomUUID: a version 4 UUID by hand.\n const bytes = new Uint8Array(16);\n if (typeof crypto?.getRandomValues === 'function') {\n crypto.getRandomValues(bytes);\n } else {\n for (let index = 0; index < bytes.length; index++) {\n bytes[index] = Math.floor(Math.random() * 256);\n }\n }\n bytes[6] = (bytes[6] & 0x0f) | 0x40;\n bytes[8] = (bytes[8] & 0x3f) | 0x80;\n const hex = Array.from(bytes, byte => byte.toString(16).padStart(2, '0'));\n return [\n hex.slice(0, 4),\n hex.slice(4, 6),\n hex.slice(6, 8),\n hex.slice(8, 10),\n hex.slice(10, 16),\n ]\n .map(group => group.join(''))\n .join('-');\n}\n\n/** Sends with the request id `requestId`, which a failure carries. */\nasync function withRequestId<T>(\n requestId: string,\n sending: () => Promise<T>,\n): Promise<T> {\n try {\n return await sending();\n } catch (error) {\n rememberRequestId(error, requestId);\n throw error;\n }\n}\n\nfunction commandHeaders(\n options: CommandOptions,\n requestId: string,\n accept?: string,\n): Record<string, string | undefined> {\n const wait = options.wait;\n return {\n [WowHeaders.REQUEST_ID]: requestId,\n [WowHeaders.WAIT]:\n wait?.plan === undefined ? undefined : formatWaitPlan(wait.plan),\n [WowHeaders.WAIT_TIMEOUT]:\n wait?.timeout === undefined ? undefined : formatWaitTimeout(wait.timeout),\n [WowHeaders.IF_MATCH]:\n options.expectedVersion === undefined\n ? undefined\n : `\"${options.expectedVersion}\"`,\n Accept: accept,\n };\n}\n\n/**\n * Sends commands to the command routes of a Wow service\n * (`POST /{context}/{aggregate}/{id}/{command}`, and without `{id}` for a\n * command that may create its aggregate). Generated aggregate clients build\n * on it; it serves any route too.\n *\n * A command that did not succeed rejects with a {@link WowProblemError}\n * holding its result, unless the options resolve it. Every command carries a\n * request id, the options' or a generated one, and whatever it rejects with\n * carries that id ({@link requestIdOf}).\n */\nexport class CommandGateway {\n /** @param client - How the service is reached */\n constructor(readonly client: WowClientOptions = {}) {}\n\n /**\n * Sends a command and answers the result its wait ends with: 200, or 202\n * for a plan that ends at `accepted`.\n *\n * @param path - The route, `{id}` filled from `id`\n * @param body - The command's body; `{}` when absent\n * @param options - Headers, wait and the aggregate id\n */\n async send<R = Record<string, unknown>>(\n path: string,\n body?: object,\n options: CreateCommandOptions = {},\n ): Promise<CommandResult<R>> {\n const requestId = options.requestId ?? newRequestId();\n try {\n return await withRequestId(requestId, async () =>\n json<CommandResult<R>>(await this.post(path, body, options, requestId)),\n );\n } catch (error) {\n if (\n options.resolveRejected &&\n error instanceof WowProblemError &&\n error.result !== undefined\n ) {\n return error.result as CommandResult<R>;\n }\n throw error;\n }\n }\n\n /**\n * Sends a command with `Accept: text/event-stream` and answers one result\n * per hop as the wait advances. An admission refusal rejects with its\n * problem; a rejection after admission is the stream's last result.\n *\n * @param path - The route, `{id}` filled from `id`\n * @param body - The command's body; `{}` when absent\n * @param options - Headers, wait and the aggregate id\n */\n async stream<R = Record<string, unknown>>(\n path: string,\n body?: object,\n options: CreateCommandOptions = {},\n ): Promise<CommandResultStream<R>> {\n const requestId = options.requestId ?? newRequestId();\n return withRequestId(requestId, async () =>\n commandResults<R>(\n await this.post(path, body, options, requestId, 'text/event-stream'),\n ),\n );\n }\n\n /**\n * Sends a lifecycle command an aggregate lists: `DELETE\n * /{context}/{aggregate}/{id}` for `DeleteAggregate`, `POST\n * …/{id}/wow.lifecycle.<kebab>` for the others.\n *\n * @param aggregatePath - `/{context}/{aggregate}`\n * @param id - The aggregate's id\n * @param command - The lifecycle command\n * @param body - Its body, for the commands that have one\n * @param options - Headers and wait\n */\n async lifecycle<R = Record<string, unknown>>(\n aggregatePath: string,\n id: string,\n command: LifecycleCommand,\n body?: TransferOwner | TransferSpace | ApplyTags,\n options: CommandOptions = {},\n ): Promise<CommandResult<R>> {\n const base = `${aggregatePath}/${encodeURIComponent(id)}`;\n if (command === LifecycleCommands.DELETE_AGGREGATE) {\n const requestId = options.requestId ?? newRequestId();\n return withRequestId(requestId, async () => {\n const response = await send(this.client, {\n method: 'DELETE',\n path: base,\n headers: commandHeaders(options, requestId),\n options,\n });\n return json<CommandResult<R>>(response);\n });\n }\n return this.send<R>(\n `${base}/${commandSegment(command)}`,\n body ?? {},\n options,\n );\n }\n\n private post(\n path: string,\n body: object | undefined,\n options: CreateCommandOptions,\n requestId: string,\n accept?: string,\n ): Promise<Response> {\n return send(this.client, {\n method: 'POST',\n path: path.includes('{id}')\n ? expandPath(path, { id: options.id ?? '' })\n : path,\n headers: commandHeaders(options, requestId, accept),\n body: body ?? {},\n ...(options.bodyNumbers === undefined\n ? {}\n : { bodyNumbers: options.bodyNumbers }),\n options,\n });\n }\n}\n"],"mappings":"4GAgEA,IAAaY,EAAoB,CAC/B,iBAAkB,gCAClB,kBAAmB,iCACnB,eAAgB,8BAChB,eAAgB,8BAChB,WAAY,yBACd,EA4BA,SAAgBC,EAAe,EAAsB,CACnD,OAAOC,EACJ,QAAQ,wBAAyB,OAAO,CAAC,CACzC,QAAQ,qBAAsB,OAAO,CAAC,CACtC,QAAQ,UAAW,GAAG,CAAC,CACvB,YAAY,CACjB,CAOA,SAAgBC,GAAuB,CACrC,IAAMC,EAAS,WAAW,OAC1B,GAAI,OAAOA,GAAQ,YAAe,WAAY,OAAOA,EAAO,WAAW,EAEvE,IAAMC,EAAQ,IAAI,WAAW,EAAE,EAC/B,GAAI,OAAOD,GAAQ,iBAAoB,WACrCA,EAAO,gBAAgBC,CAAK,OAE5B,IAAK,IAAIC,EAAQ,EAAGA,EAAQD,EAAM,OAAQ,IACxC,EAAMC,GAAS,KAAK,MAAM,KAAK,OAAO,EAAI,GAAG,EAGjD,EAAM,GAAMD,EAAM,GAAK,GAAQ,GAC/B,EAAM,GAAMA,EAAM,GAAK,GAAQ,IAC/B,IAAME,EAAM,MAAM,KAAKF,EAAO,GAAQG,EAAK,SAAS,EAAE,CAAC,CAAC,SAAS,EAAG,GAAG,CAAC,EACxE,MAAO,CACLD,EAAI,MAAM,EAAG,CAAC,EACdA,EAAI,MAAM,EAAG,CAAC,EACdA,EAAI,MAAM,EAAG,CAAC,EACdA,EAAI,MAAM,EAAG,EAAE,EACfA,EAAI,MAAM,GAAI,EAAE,CAClB,CAAC,CACE,IAAI,GAASE,EAAM,KAAK,EAAE,CAAC,CAAC,CAC5B,KAAK,GAAG,CACb,CAGA,eAAeC,EACb,EACA,EACY,CACZ,GAAI,CACF,OAAO,MAAMC,EAAQ,CACvB,OAASC,EAAO,CAEd,MADAhB,EAAA,kBAAkBgB,EAAOC,CAAS,EAC5BD,CACR,CACF,CAEA,SAASE,EACP,EACA,EACA,EACoC,CACpC,IAAMC,EAAOC,EAAQ,KACrB,MAAO,EACJ5B,EAAAA,WAAW,YAAayB,GACxBzB,EAAAA,WAAW,MACV2B,GAAM,OAAS,IAAA,GAAY,IAAA,GAAY1B,EAAAA,eAAe0B,EAAK,IAAI,GAChE3B,EAAAA,WAAW,cACV2B,GAAM,UAAY,IAAA,GAAY,IAAA,GAAYzB,EAAAA,kBAAkByB,EAAK,OAAO,GACzE3B,EAAAA,WAAW,UACV4B,EAAQ,kBAAoB,IAAA,GACxB,IAAA,GACA,IAAIA,EAAQ,gBAAgB,GAClC,OAAQC,CACV,CACF,CAaA,IAAaC,EAAb,KAA4B,CAE1B,YAAY,EAAoC,CAAC,EAAG,CAA/B,KAAA,OAAAC,CAAgC,CAUrD,MAAM,KACJ,EACA,EACA,EAAgC,CAAC,EACN,CAC3B,IAAMN,EAAYG,EAAQ,WAAab,EAAa,EACpD,GAAI,CACF,OAAO,MAAMO,EAAcG,EAAW,SACpCtB,EAAAA,KAAuB,MAAM,KAAK,KAAK6B,EAAMC,EAAML,EAASH,CAAS,CAAC,CACxE,CACF,OAASD,EAAO,CACd,GACEI,EAAQ,iBACRJ,aAAiBpB,EAAAA,iBACjBoB,EAAM,SAAW,IAAA,GAEjB,OAAOA,EAAM,OAEf,MAAMA,CACR,CACF,CAWA,MAAM,OACJ,EACA,EACA,EAAgC,CAAC,EACA,CACjC,IAAMC,EAAYG,EAAQ,WAAab,EAAa,EACpD,OAAOO,EAAcG,EAAW,SAC9BpB,EAAAA,eACE,MAAM,KAAK,KAAK2B,EAAMC,EAAML,EAASH,EAAW,mBAAmB,CACrE,CACF,CACF,CAaA,MAAM,UACJ,EACA,EACA,EACA,EACA,EAA0B,CAAC,EACA,CAC3B,IAAMS,EAAO,GAAGC,EAAc,GAAG,mBAAmBC,CAAE,IACtD,GAAIC,IAAYzB,EAAkB,iBAAkB,CAClD,IAAMa,EAAYG,EAAQ,WAAab,EAAa,EACpD,OAAOO,EAAcG,EAAW,SAAY,CAC1C,IAAMa,EAAW,MAAMhC,EAAAA,KAAK,KAAK,OAAQ,CACvC,OAAQ,SACR,KAAM4B,EACN,QAASR,EAAeE,EAASH,CAAS,EAC1C,SACF,CAAC,EACD,OAAOtB,EAAAA,KAAuBmC,CAAQ,CACxC,CAAC,CACH,CACA,OAAO,KAAK,KACV,GAAGJ,EAAK,GAAGrB,EAAewB,CAAO,IACjCJ,GAAQ,CAAC,EACTL,CACF,CACF,CAEA,KACE,EACA,EACA,EACA,EACA,EACmB,CACnB,OAAOtB,EAAAA,KAAK,KAAK,OAAQ,CACvB,OAAQ,OACR,KAAM0B,EAAK,SAAS,MAAM,EACtBzB,EAAAA,WAAWyB,EAAM,CAAE,GAAIJ,EAAQ,IAAM,EAAG,CAAC,EACzCI,EACJ,QAASN,EAAeE,EAASH,EAAWI,CAAM,EAClD,KAAMI,GAAQ,CAAC,EACf,GAAIL,EAAQ,cAAgB,IAAA,GACxB,CAAC,EACD,CAAE,YAAaA,EAAQ,WAAY,EACvC,SACF,CAAC,CACH,CACF"}
@@ -1,3 +1,4 @@
1
+ import { TextNumbers } from './exactJson.cjs';
1
2
  import { RequestOptions, WowClientOptions } from './http.cjs';
2
3
  import { CommandResult } from './wire.cjs';
3
4
  import { CommandResultStream } from './streams.cjs';
@@ -6,13 +7,22 @@ import { WaitOptions } from './wait.cjs';
6
7
  export interface CommandOptions extends RequestOptions {
7
8
  /**
8
9
  * The request id (`Wow-Request-Id`): a retry with the same one is
9
- * deduplicated, answered as the first commit's duplicate.
10
+ * deduplicated, answered as the first commit's duplicate. When absent, the
11
+ * gateway generates one ({@link newRequestId}), which a failure carries
12
+ * ({@link requestIdOf}): retry with it, not with a new one.
10
13
  */
11
14
  readonly requestId?: string;
12
15
  /** What to wait for, and for how long. */
13
16
  readonly wait?: WaitOptions;
14
17
  /** The version the aggregate must be at (`If-Match`). */
15
18
  readonly expectedVersion?: number;
19
+ /**
20
+ * The body's numbers written as their exact text, unquoted JSON numbers
21
+ * (review R4-Q, Q-9; decision D122): a generated client sets it for a
22
+ * command with `int64`, `bigint` or `decimal` fields, which it types as
23
+ * `string`.
24
+ */
25
+ readonly bodyNumbers?: TextNumbers;
16
26
  /**
17
27
  * Resolve a result that did not succeed instead of rejecting with its
18
28
  * {@link WowProblemError}; `false` by default.
@@ -58,13 +68,21 @@ export interface ApplyTags {
58
68
  */
59
69
  export declare function commandSegment(name: string): string;
60
70
  /**
61
- * Sends commands to the command routes of a Wow V10 service
71
+ * A new request id (`Wow-Request-Id`): a random UUID. The gateway generates
72
+ * one for a command sent without; generate it first to retry with it however
73
+ * the request fails.
74
+ */
75
+ export declare function newRequestId(): string;
76
+ /**
77
+ * Sends commands to the command routes of a Wow service
62
78
  * (`POST /{context}/{aggregate}/{id}/{command}`, and without `{id}` for a
63
79
  * command that may create its aggregate). Generated aggregate clients build
64
80
  * on it; it serves any route too.
65
81
  *
66
82
  * A command that did not succeed rejects with a {@link WowProblemError}
67
- * holding its result, unless the options resolve it.
83
+ * holding its result, unless the options resolve it. Every command carries a
84
+ * request id, the options' or a generated one, and whatever it rejects with
85
+ * carries that id ({@link requestIdOf}).
68
86
  */
69
87
  export declare class CommandGateway {
70
88
  readonly client: WowClientOptions;
@@ -1,3 +1,4 @@
1
+ import { TextNumbers } from './exactJson.js';
1
2
  import { RequestOptions, WowClientOptions } from './http.js';
2
3
  import { CommandResult } from './wire.js';
3
4
  import { CommandResultStream } from './streams.js';
@@ -6,13 +7,22 @@ import { WaitOptions } from './wait.js';
6
7
  export interface CommandOptions extends RequestOptions {
7
8
  /**
8
9
  * The request id (`Wow-Request-Id`): a retry with the same one is
9
- * deduplicated, answered as the first commit's duplicate.
10
+ * deduplicated, answered as the first commit's duplicate. When absent, the
11
+ * gateway generates one ({@link newRequestId}), which a failure carries
12
+ * ({@link requestIdOf}): retry with it, not with a new one.
10
13
  */
11
14
  readonly requestId?: string;
12
15
  /** What to wait for, and for how long. */
13
16
  readonly wait?: WaitOptions;
14
17
  /** The version the aggregate must be at (`If-Match`). */
15
18
  readonly expectedVersion?: number;
19
+ /**
20
+ * The body's numbers written as their exact text, unquoted JSON numbers
21
+ * (review R4-Q, Q-9; decision D122): a generated client sets it for a
22
+ * command with `int64`, `bigint` or `decimal` fields, which it types as
23
+ * `string`.
24
+ */
25
+ readonly bodyNumbers?: TextNumbers;
16
26
  /**
17
27
  * Resolve a result that did not succeed instead of rejecting with its
18
28
  * {@link WowProblemError}; `false` by default.
@@ -58,13 +68,21 @@ export interface ApplyTags {
58
68
  */
59
69
  export declare function commandSegment(name: string): string;
60
70
  /**
61
- * Sends commands to the command routes of a Wow V10 service
71
+ * A new request id (`Wow-Request-Id`): a random UUID. The gateway generates
72
+ * one for a command sent without; generate it first to retry with it however
73
+ * the request fails.
74
+ */
75
+ export declare function newRequestId(): string;
76
+ /**
77
+ * Sends commands to the command routes of a Wow service
62
78
  * (`POST /{context}/{aggregate}/{id}/{command}`, and without `{id}` for a
63
79
  * command that may create its aggregate). Generated aggregate clients build
64
80
  * on it; it serves any route too.
65
81
  *
66
82
  * A command that did not succeed rejects with a {@link WowProblemError}
67
- * holding its result, unless the options resolve it.
83
+ * holding its result, unless the options resolve it. Every command carries a
84
+ * request id, the options' or a generated one, and whatever it rejects with
85
+ * carries that id ({@link requestIdOf}).
68
86
  */
69
87
  export declare class CommandGateway {
70
88
  readonly client: WowClientOptions;
@@ -0,0 +1,96 @@
1
+ import { WowProblemError as e, rememberRequestId as t } from "./problem.es.js";
2
+ import { WowHeaders as n, expandPath as r, json as i, send as a } from "./http.es.js";
3
+ import { commandResults as o } from "./streams.es.js";
4
+ import { formatWaitPlan as s, formatWaitTimeout as c } from "./wait.es.js";
5
+ //#region src/commands.ts
6
+ var l = {
7
+ DELETE_AGGREGATE: "wow.lifecycle.DeleteAggregate",
8
+ RESTORE_AGGREGATE: "wow.lifecycle.RestoreAggregate",
9
+ TRANSFER_OWNER: "wow.lifecycle.TransferOwner",
10
+ TRANSFER_SPACE: "wow.lifecycle.TransferSpace",
11
+ APPLY_TAGS: "wow.lifecycle.ApplyTags"
12
+ };
13
+ function u(e) {
14
+ return e.replace(/([A-Z]+)([A-Z][a-z])/g, "$1-$2").replace(/([a-z0-9])([A-Z])/g, "$1-$2").replace(/[_\s]+/g, "-").toLowerCase();
15
+ }
16
+ function d() {
17
+ let e = globalThis.crypto;
18
+ if (typeof e?.randomUUID == "function") return e.randomUUID();
19
+ let t = /* @__PURE__ */ new Uint8Array(16);
20
+ if (typeof e?.getRandomValues == "function") e.getRandomValues(t);
21
+ else for (let e = 0; e < t.length; e++) t[e] = Math.floor(Math.random() * 256);
22
+ t[6] = t[6] & 15 | 64, t[8] = t[8] & 63 | 128;
23
+ let n = Array.from(t, (e) => e.toString(16).padStart(2, "0"));
24
+ return [
25
+ n.slice(0, 4),
26
+ n.slice(4, 6),
27
+ n.slice(6, 8),
28
+ n.slice(8, 10),
29
+ n.slice(10, 16)
30
+ ].map((e) => e.join("")).join("-");
31
+ }
32
+ async function f(e, n) {
33
+ try {
34
+ return await n();
35
+ } catch (n) {
36
+ throw t(n, e), n;
37
+ }
38
+ }
39
+ function p(e, t, r) {
40
+ let i = e.wait;
41
+ return {
42
+ [n.REQUEST_ID]: t,
43
+ [n.WAIT]: i?.plan === void 0 ? void 0 : s(i.plan),
44
+ [n.WAIT_TIMEOUT]: i?.timeout === void 0 ? void 0 : c(i.timeout),
45
+ [n.IF_MATCH]: e.expectedVersion === void 0 ? void 0 : `"${e.expectedVersion}"`,
46
+ Accept: r
47
+ };
48
+ }
49
+ var m = class {
50
+ constructor(e = {}) {
51
+ this.client = e;
52
+ }
53
+ async send(t, n, r = {}) {
54
+ let a = r.requestId ?? d();
55
+ try {
56
+ return await f(a, async () => i(await this.post(t, n, r, a)));
57
+ } catch (t) {
58
+ if (r.resolveRejected && t instanceof e && t.result !== void 0) return t.result;
59
+ throw t;
60
+ }
61
+ }
62
+ async stream(e, t, n = {}) {
63
+ let r = n.requestId ?? d();
64
+ return f(r, async () => o(await this.post(e, t, n, r, "text/event-stream")));
65
+ }
66
+ async lifecycle(e, t, n, r, o = {}) {
67
+ let s = `${e}/${encodeURIComponent(t)}`;
68
+ if (n === l.DELETE_AGGREGATE) {
69
+ let e = o.requestId ?? d();
70
+ return f(e, async () => {
71
+ let t = await a(this.client, {
72
+ method: "DELETE",
73
+ path: s,
74
+ headers: p(o, e),
75
+ options: o
76
+ });
77
+ return i(t);
78
+ });
79
+ }
80
+ return this.send(`${s}/${u(n)}`, r ?? {}, o);
81
+ }
82
+ post(e, t, n, i, o) {
83
+ return a(this.client, {
84
+ method: "POST",
85
+ path: e.includes("{id}") ? r(e, { id: n.id ?? "" }) : e,
86
+ headers: p(n, i, o),
87
+ body: t ?? {},
88
+ ...n.bodyNumbers === void 0 ? {} : { bodyNumbers: n.bodyNumbers },
89
+ options: n
90
+ });
91
+ }
92
+ };
93
+ //#endregion
94
+ export { m as CommandGateway, l as LifecycleCommands, u as commandSegment, d as newRequestId };
95
+
96
+ //# sourceMappingURL=commands.es.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"commands.es.js","names":["LifecycleCommands","commandSegment","name","newRequestId","crypto","bytes","index","hex","byte","group","withRequestId","sending","error","rememberRequestId","requestId","commandHeaders","wait","options","WowHeaders","formatWaitPlan","formatWaitTimeout","accept","CommandGateway","client","json","path","body","WowProblemError","commandResults","base","aggregatePath","id","command","response","send","expandPath"],"sources":["../src/commands.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { TextNumbers } from './exactJson.js';\nimport {\n expandPath,\n json,\n type RequestOptions,\n send,\n type WowClientOptions,\n WowHeaders,\n} from './http.js';\nimport type { CommandResult } from './wire.js';\nimport { rememberRequestId, WowProblemError } from './problem.js';\nimport { commandResults, type CommandResultStream } from './streams.js';\nimport { formatWaitPlan, formatWaitTimeout, type WaitOptions } from './wait.js';\n\n/** What a command request carries beside its body (decisions D95–D99). */\nexport interface CommandOptions extends RequestOptions {\n /**\n * The request id (`Wow-Request-Id`): a retry with the same one is\n * deduplicated, answered as the first commit's duplicate. When absent, the\n * gateway generates one ({@link newRequestId}), which a failure carries\n * ({@link requestIdOf}): retry with it, not with a new one.\n */\n readonly requestId?: string;\n /** What to wait for, and for how long. */\n readonly wait?: WaitOptions;\n /** The version the aggregate must be at (`If-Match`). */\n readonly expectedVersion?: number;\n /**\n * The body's numbers written as their exact text, unquoted JSON numbers\n * (review R4-Q, Q-9; decision D122): a generated client sets it for a\n * command with `int64`, `bigint` or `decimal` fields, which it types as\n * `string`.\n */\n readonly bodyNumbers?: TextNumbers;\n /**\n * Resolve a result that did not succeed instead of rejecting with its\n * {@link WowProblemError}; `false` by default.\n */\n readonly resolveRejected?: boolean;\n}\n\n/** The options of a command whose route may name the aggregate id or not. */\nexport interface CreateCommandOptions extends CommandOptions {\n /**\n * The id of the aggregate to create (decision D176); the service generates\n * one when absent.\n */\n readonly id?: string;\n}\n\n/** The lifecycle commands an aggregate may list (decision D113). */\nexport const LifecycleCommands = {\n DELETE_AGGREGATE: 'wow.lifecycle.DeleteAggregate',\n RESTORE_AGGREGATE: 'wow.lifecycle.RestoreAggregate',\n TRANSFER_OWNER: 'wow.lifecycle.TransferOwner',\n TRANSFER_SPACE: 'wow.lifecycle.TransferSpace',\n APPLY_TAGS: 'wow.lifecycle.ApplyTags',\n} as const;\n\n/** A {@link LifecycleCommands} value. */\nexport type LifecycleCommand =\n (typeof LifecycleCommands)[keyof typeof LifecycleCommands];\n\n/** The body of `wow.lifecycle.TransferOwner`. */\nexport interface TransferOwner {\n readonly ownerId: string;\n}\n\n/** The body of `wow.lifecycle.TransferSpace`. */\nexport interface TransferSpace {\n readonly spaceId: string;\n}\n\n/** The body of `wow.lifecycle.ApplyTags`: the tags, names to values. */\nexport interface ApplyTags {\n readonly tags: Readonly<Record<string, readonly string[]>>;\n}\n\n/**\n * The route segment of a command name, as the server derives it: kebab case,\n * dots kept (`AddCartItem` → `add-cart-item`,\n * `wow.lifecycle.RestoreAggregate` → `wow.lifecycle.restore-aggregate`).\n *\n * @param name - The command's name\n */\nexport function commandSegment(name: string): string {\n return name\n .replace(/([A-Z]+)([A-Z][a-z])/g, '$1-$2')\n .replace(/([a-z0-9])([A-Z])/g, '$1-$2')\n .replace(/[_\\s]+/g, '-')\n .toLowerCase();\n}\n\n/**\n * A new request id (`Wow-Request-Id`): a random UUID. The gateway generates\n * one for a command sent without; generate it first to retry with it however\n * the request fails.\n */\nexport function newRequestId(): string {\n const crypto = globalThis.crypto;\n if (typeof crypto?.randomUUID === 'function') return crypto.randomUUID();\n // An insecure browser context has no randomUUID: a version 4 UUID by hand.\n const bytes = new Uint8Array(16);\n if (typeof crypto?.getRandomValues === 'function') {\n crypto.getRandomValues(bytes);\n } else {\n for (let index = 0; index < bytes.length; index++) {\n bytes[index] = Math.floor(Math.random() * 256);\n }\n }\n bytes[6] = (bytes[6] & 0x0f) | 0x40;\n bytes[8] = (bytes[8] & 0x3f) | 0x80;\n const hex = Array.from(bytes, byte => byte.toString(16).padStart(2, '0'));\n return [\n hex.slice(0, 4),\n hex.slice(4, 6),\n hex.slice(6, 8),\n hex.slice(8, 10),\n hex.slice(10, 16),\n ]\n .map(group => group.join(''))\n .join('-');\n}\n\n/** Sends with the request id `requestId`, which a failure carries. */\nasync function withRequestId<T>(\n requestId: string,\n sending: () => Promise<T>,\n): Promise<T> {\n try {\n return await sending();\n } catch (error) {\n rememberRequestId(error, requestId);\n throw error;\n }\n}\n\nfunction commandHeaders(\n options: CommandOptions,\n requestId: string,\n accept?: string,\n): Record<string, string | undefined> {\n const wait = options.wait;\n return {\n [WowHeaders.REQUEST_ID]: requestId,\n [WowHeaders.WAIT]:\n wait?.plan === undefined ? undefined : formatWaitPlan(wait.plan),\n [WowHeaders.WAIT_TIMEOUT]:\n wait?.timeout === undefined ? undefined : formatWaitTimeout(wait.timeout),\n [WowHeaders.IF_MATCH]:\n options.expectedVersion === undefined\n ? undefined\n : `\"${options.expectedVersion}\"`,\n Accept: accept,\n };\n}\n\n/**\n * Sends commands to the command routes of a Wow service\n * (`POST /{context}/{aggregate}/{id}/{command}`, and without `{id}` for a\n * command that may create its aggregate). Generated aggregate clients build\n * on it; it serves any route too.\n *\n * A command that did not succeed rejects with a {@link WowProblemError}\n * holding its result, unless the options resolve it. Every command carries a\n * request id, the options' or a generated one, and whatever it rejects with\n * carries that id ({@link requestIdOf}).\n */\nexport class CommandGateway {\n /** @param client - How the service is reached */\n constructor(readonly client: WowClientOptions = {}) {}\n\n /**\n * Sends a command and answers the result its wait ends with: 200, or 202\n * for a plan that ends at `accepted`.\n *\n * @param path - The route, `{id}` filled from `id`\n * @param body - The command's body; `{}` when absent\n * @param options - Headers, wait and the aggregate id\n */\n async send<R = Record<string, unknown>>(\n path: string,\n body?: object,\n options: CreateCommandOptions = {},\n ): Promise<CommandResult<R>> {\n const requestId = options.requestId ?? newRequestId();\n try {\n return await withRequestId(requestId, async () =>\n json<CommandResult<R>>(await this.post(path, body, options, requestId)),\n );\n } catch (error) {\n if (\n options.resolveRejected &&\n error instanceof WowProblemError &&\n error.result !== undefined\n ) {\n return error.result as CommandResult<R>;\n }\n throw error;\n }\n }\n\n /**\n * Sends a command with `Accept: text/event-stream` and answers one result\n * per hop as the wait advances. An admission refusal rejects with its\n * problem; a rejection after admission is the stream's last result.\n *\n * @param path - The route, `{id}` filled from `id`\n * @param body - The command's body; `{}` when absent\n * @param options - Headers, wait and the aggregate id\n */\n async stream<R = Record<string, unknown>>(\n path: string,\n body?: object,\n options: CreateCommandOptions = {},\n ): Promise<CommandResultStream<R>> {\n const requestId = options.requestId ?? newRequestId();\n return withRequestId(requestId, async () =>\n commandResults<R>(\n await this.post(path, body, options, requestId, 'text/event-stream'),\n ),\n );\n }\n\n /**\n * Sends a lifecycle command an aggregate lists: `DELETE\n * /{context}/{aggregate}/{id}` for `DeleteAggregate`, `POST\n * …/{id}/wow.lifecycle.<kebab>` for the others.\n *\n * @param aggregatePath - `/{context}/{aggregate}`\n * @param id - The aggregate's id\n * @param command - The lifecycle command\n * @param body - Its body, for the commands that have one\n * @param options - Headers and wait\n */\n async lifecycle<R = Record<string, unknown>>(\n aggregatePath: string,\n id: string,\n command: LifecycleCommand,\n body?: TransferOwner | TransferSpace | ApplyTags,\n options: CommandOptions = {},\n ): Promise<CommandResult<R>> {\n const base = `${aggregatePath}/${encodeURIComponent(id)}`;\n if (command === LifecycleCommands.DELETE_AGGREGATE) {\n const requestId = options.requestId ?? newRequestId();\n return withRequestId(requestId, async () => {\n const response = await send(this.client, {\n method: 'DELETE',\n path: base,\n headers: commandHeaders(options, requestId),\n options,\n });\n return json<CommandResult<R>>(response);\n });\n }\n return this.send<R>(\n `${base}/${commandSegment(command)}`,\n body ?? {},\n options,\n );\n }\n\n private post(\n path: string,\n body: object | undefined,\n options: CreateCommandOptions,\n requestId: string,\n accept?: string,\n ): Promise<Response> {\n return send(this.client, {\n method: 'POST',\n path: path.includes('{id}')\n ? expandPath(path, { id: options.id ?? '' })\n : path,\n headers: commandHeaders(options, requestId, accept),\n body: body ?? {},\n ...(options.bodyNumbers === undefined\n ? {}\n : { bodyNumbers: options.bodyNumbers }),\n options,\n });\n }\n}\n"],"mappings":";;;;;AAgEA,IAAaA,IAAoB;CAC/B,kBAAkB;CAClB,mBAAmB;CACnB,gBAAgB;CAChB,gBAAgB;CAChB,YAAY;AACd;AA4BA,SAAgBC,EAAe,GAAsB;CACnD,OAAOC,EACJ,QAAQ,yBAAyB,OAAO,CAAC,CACzC,QAAQ,sBAAsB,OAAO,CAAC,CACtC,QAAQ,WAAW,GAAG,CAAC,CACvB,YAAY;AACjB;AAOA,SAAgBC,IAAuB;CACrC,IAAMC,IAAS,WAAW;CAC1B,IAAI,OAAOA,GAAQ,cAAe,YAAY,OAAOA,EAAO,WAAW;CAEvE,IAAMC,oBAAQ,IAAI,WAAW,EAAE;CAC/B,IAAI,OAAOD,GAAQ,mBAAoB,YACrC,EAAO,gBAAgBC,CAAK;MAE5B,KAAK,IAAIC,IAAQ,GAAGA,IAAQD,EAAM,QAAQ,KACxC,EAAMC,KAAS,KAAK,MAAM,KAAK,OAAO,IAAI,GAAG;CAIjD,AADA,EAAM,KAAMD,EAAM,KAAK,KAAQ,IAC/B,EAAM,KAAMA,EAAM,KAAK,KAAQ;CAC/B,IAAME,IAAM,MAAM,KAAKF,IAAO,MAAQG,EAAK,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC;CACxE,OAAO;EACLD,EAAI,MAAM,GAAG,CAAC;EACdA,EAAI,MAAM,GAAG,CAAC;EACdA,EAAI,MAAM,GAAG,CAAC;EACdA,EAAI,MAAM,GAAG,EAAE;EACfA,EAAI,MAAM,IAAI,EAAE;CAClB,CAAC,CACE,KAAI,MAASE,EAAM,KAAK,EAAE,CAAC,CAAC,CAC5B,KAAK,GAAG;AACb;AAGA,eAAeC,EACb,GACA,GACY;CACZ,IAAI;EACF,OAAO,MAAMC,EAAQ;CACvB,SAASC,GAAO;EAEd,MADAC,EAAkBD,GAAOE,CAAS,GAC5BF;CACR;AACF;AAEA,SAASG,EACP,GACA,GACA,GACoC;CACpC,IAAMC,IAAOC,EAAQ;CACrB,OAAO;GACJC,EAAW,aAAaJ;GACxBI,EAAW,OACVF,GAAM,SAAS,KAAA,IAAY,KAAA,IAAYG,EAAeH,EAAK,IAAI;GAChEE,EAAW,eACVF,GAAM,YAAY,KAAA,IAAY,KAAA,IAAYI,EAAkBJ,EAAK,OAAO;GACzEE,EAAW,WACVD,EAAQ,oBAAoB,KAAA,IACxB,KAAA,IACA,IAAIA,EAAQ,gBAAgB;EAClC,QAAQI;CACV;AACF;AAaA,IAAaC,IAAb,MAA4B;CAE1B,YAAY,IAAoC,CAAC,GAAG;EAA/B,KAAA,SAAAC;CAAgC;CAUrD,MAAM,KACJ,GACA,GACA,IAAgC,CAAC,GACN;EAC3B,IAAMT,IAAYG,EAAQ,aAAad,EAAa;EACpD,IAAI;GACF,OAAO,MAAMO,EAAcI,GAAW,YACpCU,EAAuB,MAAM,KAAK,KAAKC,GAAMC,GAAMT,GAASH,CAAS,CAAC,CACxE;EACF,SAASF,GAAO;GACd,IACEK,EAAQ,mBACRL,aAAiBe,KACjBf,EAAM,WAAW,KAAA,GAEjB,OAAOA,EAAM;GAEf,MAAMA;EACR;CACF;CAWA,MAAM,OACJ,GACA,GACA,IAAgC,CAAC,GACA;EACjC,IAAME,IAAYG,EAAQ,aAAad,EAAa;EACpD,OAAOO,EAAcI,GAAW,YAC9Bc,EACE,MAAM,KAAK,KAAKH,GAAMC,GAAMT,GAASH,GAAW,mBAAmB,CACrE,CACF;CACF;CAaA,MAAM,UACJ,GACA,GACA,GACA,GACA,IAA0B,CAAC,GACA;EAC3B,IAAMe,IAAO,GAAGC,EAAc,GAAG,mBAAmBC,CAAE;EACtD,IAAIC,MAAYhC,EAAkB,kBAAkB;GAClD,IAAMc,IAAYG,EAAQ,aAAad,EAAa;GACpD,OAAOO,EAAcI,GAAW,YAAY;IAC1C,IAAMmB,IAAW,MAAMC,EAAK,KAAK,QAAQ;KACvC,QAAQ;KACR,MAAML;KACN,SAASd,EAAeE,GAASH,CAAS;KAC1C;IACF,CAAC;IACD,OAAOU,EAAuBS,CAAQ;GACxC,CAAC;EACH;EACA,OAAO,KAAK,KACV,GAAGJ,EAAK,GAAG5B,EAAe+B,CAAO,KACjCN,KAAQ,CAAC,GACTT,CACF;CACF;CAEA,KACE,GACA,GACA,GACA,GACA,GACmB;EACnB,OAAOiB,EAAK,KAAK,QAAQ;GACvB,QAAQ;GACR,MAAMT,EAAK,SAAS,MAAM,IACtBU,EAAWV,GAAM,EAAE,IAAIR,EAAQ,MAAM,GAAG,CAAC,IACzCQ;GACJ,SAASV,EAAeE,GAASH,GAAWO,CAAM;GAClD,MAAMK,KAAQ,CAAC;GACf,GAAIT,EAAQ,gBAAgB,KAAA,IACxB,CAAC,IACD,EAAE,aAAaA,EAAQ,YAAY;GACvC;EACF,CAAC;CACH;AACF"}