@vtex/api 6.48.1-beta → 6.48.1-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (440) hide show
  1. package/gen/manifest.schema +5 -3
  2. package/lib/HttpClient/GraphQLClient.d.ts +3 -2
  3. package/lib/HttpClient/GraphQLClient.js +5 -1
  4. package/lib/HttpClient/HttpClient.d.ts +9 -7
  5. package/lib/HttpClient/HttpClient.js +70 -27
  6. package/lib/HttpClient/agents.d.ts +6 -0
  7. package/lib/HttpClient/agents.js +43 -0
  8. package/lib/HttpClient/index.d.ts +1 -7
  9. package/lib/HttpClient/index.js +22 -16
  10. package/lib/HttpClient/middlewares/cache.d.ts +9 -3
  11. package/lib/HttpClient/middlewares/cache.js +130 -35
  12. package/lib/HttpClient/middlewares/cancellationToken.d.ts +2 -2
  13. package/lib/HttpClient/middlewares/cancellationToken.js +5 -2
  14. package/lib/HttpClient/middlewares/inflight.d.ts +1 -1
  15. package/lib/HttpClient/middlewares/inflight.js +7 -3
  16. package/lib/HttpClient/middlewares/memoization.d.ts +1 -1
  17. package/lib/HttpClient/middlewares/memoization.js +13 -4
  18. package/lib/HttpClient/middlewares/metrics.js +25 -38
  19. package/lib/HttpClient/middlewares/notFound.d.ts +1 -1
  20. package/lib/HttpClient/middlewares/notFound.js +5 -2
  21. package/lib/HttpClient/middlewares/recorder.d.ts +1 -1
  22. package/lib/HttpClient/middlewares/recorder.js +21 -12
  23. package/lib/HttpClient/middlewares/request/HttpAgentSingleton.d.ts +11 -0
  24. package/lib/HttpClient/middlewares/request/HttpAgentSingleton.js +31 -0
  25. package/lib/HttpClient/middlewares/request/index.d.ts +18 -0
  26. package/lib/HttpClient/middlewares/request/index.js +88 -0
  27. package/lib/HttpClient/middlewares/request/setupAxios/index.d.ts +1 -0
  28. package/lib/HttpClient/middlewares/request/setupAxios/index.js +22 -0
  29. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/exponentialBackoff.d.ts +2 -0
  30. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/exponentialBackoff.js +55 -0
  31. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/index.d.ts +2 -0
  32. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/index.js +8 -0
  33. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/tracing/index.d.ts +8 -0
  34. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/tracing/index.js +56 -0
  35. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/tracing/spanSetup.d.ts +4 -0
  36. package/lib/HttpClient/middlewares/request/setupAxios/interceptors/tracing/spanSetup.js +32 -0
  37. package/lib/HttpClient/middlewares/tracing.d.ts +15 -0
  38. package/lib/HttpClient/middlewares/tracing.js +62 -0
  39. package/lib/HttpClient/typings.d.ts +46 -12
  40. package/lib/HttpClient/typings.js +1 -0
  41. package/lib/caches/DiskCache.d.ts +1 -1
  42. package/lib/caches/DiskCache.js +3 -2
  43. package/lib/caches/LRUCache.d.ts +3 -3
  44. package/lib/caches/LRUCache.js +6 -1
  45. package/lib/caches/LRUDiskCache.d.ts +2 -2
  46. package/lib/caches/LRUDiskCache.js +8 -3
  47. package/lib/caches/MultilayeredCache.d.ts +2 -2
  48. package/lib/caches/MultilayeredCache.js +8 -7
  49. package/lib/caches/index.js +20 -7
  50. package/lib/caches/typings.d.ts +5 -5
  51. package/lib/clients/IOClient.d.ts +13 -0
  52. package/lib/clients/IOClient.js +20 -0
  53. package/lib/clients/IOClients.d.ts +29 -25
  54. package/lib/clients/IOClients.js +36 -28
  55. package/lib/{HttpClient → clients}/IOGraphQLClient.d.ts +4 -4
  56. package/lib/{HttpClient → clients}/IOGraphQLClient.js +3 -2
  57. package/lib/{HttpClient → clients/apps}/AppClient.d.ts +3 -3
  58. package/lib/{HttpClient → clients/apps}/AppClient.js +11 -5
  59. package/lib/{HttpClient → clients/apps}/AppGraphQLClient.d.ts +3 -3
  60. package/lib/{HttpClient → clients/apps}/AppGraphQLClient.js +11 -5
  61. package/lib/clients/apps/Billing.d.ts +12 -0
  62. package/lib/clients/{Billing.js → apps/Billing.js} +9 -3
  63. package/lib/clients/{Builder.d.ts → apps/Builder.d.ts} +12 -11
  64. package/lib/clients/{Builder.js → apps/Builder.js} +51 -23
  65. package/lib/clients/apps/MessagesGraphQL.d.ts +61 -0
  66. package/lib/clients/apps/MessagesGraphQL.js +122 -0
  67. package/lib/clients/{Settings.d.ts → apps/Settings.d.ts} +5 -4
  68. package/lib/clients/apps/Settings.js +39 -0
  69. package/lib/clients/apps/catalogGraphQL/brand.d.ts +13 -0
  70. package/lib/clients/apps/catalogGraphQL/brand.js +19 -0
  71. package/lib/clients/apps/catalogGraphQL/category.d.ts +11 -0
  72. package/lib/clients/apps/catalogGraphQL/category.js +17 -0
  73. package/lib/clients/apps/catalogGraphQL/index.d.ts +22 -0
  74. package/lib/clients/apps/catalogGraphQL/index.js +89 -0
  75. package/lib/clients/apps/catalogGraphQL/product.d.ts +25 -0
  76. package/lib/clients/apps/catalogGraphQL/product.js +31 -0
  77. package/lib/clients/apps/catalogGraphQL/sku.d.ts +26 -0
  78. package/lib/clients/apps/catalogGraphQL/sku.js +31 -0
  79. package/lib/clients/apps/index.d.ts +7 -0
  80. package/lib/clients/apps/index.js +23 -0
  81. package/lib/{HttpClient → clients/external}/ExternalClient.d.ts +3 -3
  82. package/lib/{HttpClient → clients/external}/ExternalClient.js +10 -2
  83. package/lib/clients/external/ID.d.ts +23 -0
  84. package/lib/clients/external/ID.js +61 -0
  85. package/lib/clients/external/Masterdata.d.ts +94 -0
  86. package/lib/clients/external/Masterdata.js +225 -0
  87. package/lib/clients/external/PaymentProvider.d.ts +31 -0
  88. package/lib/clients/external/PaymentProvider.js +43 -0
  89. package/lib/clients/external/index.d.ts +4 -0
  90. package/lib/clients/external/index.js +20 -0
  91. package/lib/clients/index.d.ts +9 -21
  92. package/lib/clients/index.js +27 -24
  93. package/lib/clients/infra/Apps.d.ts +93 -0
  94. package/lib/clients/infra/Apps.js +511 -0
  95. package/lib/clients/infra/Assets.d.ts +35 -0
  96. package/lib/clients/infra/Assets.js +166 -0
  97. package/lib/clients/infra/BillingMetrics.d.ts +13 -0
  98. package/lib/clients/infra/BillingMetrics.js +16 -0
  99. package/lib/clients/infra/Events.d.ts +12 -0
  100. package/lib/clients/infra/Events.js +34 -0
  101. package/lib/clients/infra/Housekeeper.d.ts +10 -0
  102. package/lib/clients/infra/Housekeeper.js +31 -0
  103. package/lib/{HttpClient → clients/infra}/InfraClient.d.ts +3 -3
  104. package/lib/{HttpClient → clients/infra}/InfraClient.js +10 -4
  105. package/lib/clients/infra/Registry.d.ts +65 -0
  106. package/lib/clients/infra/Registry.js +209 -0
  107. package/lib/clients/infra/Router.d.ts +34 -0
  108. package/lib/clients/infra/Router.js +82 -0
  109. package/lib/clients/infra/Sphinx.d.ts +13 -0
  110. package/lib/clients/infra/Sphinx.js +30 -0
  111. package/lib/clients/infra/VBase.d.ts +61 -0
  112. package/lib/clients/infra/VBase.js +197 -0
  113. package/lib/clients/infra/Workspaces.d.ts +18 -0
  114. package/lib/clients/infra/Workspaces.js +66 -0
  115. package/lib/clients/infra/index.d.ts +11 -0
  116. package/lib/clients/infra/index.js +27 -0
  117. package/lib/{HttpClient → clients/janus}/JanusClient.d.ts +4 -4
  118. package/lib/{HttpClient → clients/janus}/JanusClient.js +8 -3
  119. package/lib/clients/janus/LicenseManager.d.ts +7 -0
  120. package/lib/clients/janus/LicenseManager.js +59 -0
  121. package/lib/clients/{Segment.d.ts → janus/Segment.d.ts} +7 -11
  122. package/lib/clients/janus/Segment.js +89 -0
  123. package/lib/clients/{Session.d.ts → janus/Session.d.ts} +4 -4
  124. package/lib/clients/{Session.js → janus/Session.js} +25 -13
  125. package/lib/clients/{Tenant.d.ts → janus/Tenant.d.ts} +7 -8
  126. package/lib/clients/janus/Tenant.js +29 -0
  127. package/lib/clients/janus/index.d.ts +5 -0
  128. package/lib/clients/janus/index.js +21 -0
  129. package/lib/constants.d.ts +50 -2
  130. package/lib/constants.js +55 -1
  131. package/lib/errors/AuthenticationError.js +1 -0
  132. package/lib/errors/ForbiddenError.js +1 -0
  133. package/lib/errors/NotFoundError.js +1 -0
  134. package/lib/errors/RequestCancelledError.js +1 -0
  135. package/lib/errors/ResolverError.d.ts +1 -1
  136. package/lib/errors/ResolverError.js +4 -3
  137. package/lib/errors/ResolverWarning.d.ts +1 -1
  138. package/lib/errors/ResolverWarning.js +3 -2
  139. package/lib/errors/TooManyRequestsError.js +1 -0
  140. package/lib/errors/UserInputError.js +1 -0
  141. package/lib/errors/index.js +22 -11
  142. package/lib/index.d.ts +9 -7
  143. package/lib/index.js +31 -16
  144. package/lib/metrics/MetricsAccumulator.d.ts +3 -20
  145. package/lib/metrics/MetricsAccumulator.js +44 -27
  146. package/lib/responses.d.ts +5 -46
  147. package/lib/service/index.d.ts +2 -0
  148. package/lib/service/index.js +35 -0
  149. package/lib/service/loaders.d.ts +8 -0
  150. package/lib/service/loaders.js +57 -0
  151. package/lib/service/logger/console.d.ts +10 -0
  152. package/lib/service/logger/console.js +40 -0
  153. package/lib/service/logger/index.d.ts +2 -28
  154. package/lib/service/logger/index.js +16 -68
  155. package/lib/service/logger/logger.d.ts +29 -0
  156. package/lib/service/logger/logger.js +62 -0
  157. package/lib/service/logger/metricsLogger.d.ts +40 -0
  158. package/lib/service/logger/metricsLogger.js +150 -0
  159. package/lib/service/master.d.ts +2 -0
  160. package/lib/service/master.js +89 -0
  161. package/lib/service/metrics/requestMetricsMiddleware.d.ts +2 -0
  162. package/lib/service/metrics/requestMetricsMiddleware.js +46 -0
  163. package/lib/service/tracing/TracerSingleton.d.ts +7 -0
  164. package/lib/service/tracing/TracerSingleton.js +49 -0
  165. package/lib/service/tracing/metrics/MetricNames.d.ts +60 -0
  166. package/lib/service/tracing/metrics/MetricNames.js +45 -0
  167. package/lib/service/tracing/metrics/instruments.d.ts +9 -0
  168. package/lib/service/tracing/metrics/instruments.js +19 -0
  169. package/lib/service/tracing/metrics/measurers/EventLoopLagMeasurer.d.ts +9 -0
  170. package/lib/service/tracing/metrics/measurers/EventLoopLagMeasurer.js +26 -0
  171. package/lib/service/tracing/tracingMiddlewares.d.ts +5 -0
  172. package/lib/service/tracing/tracingMiddlewares.js +117 -0
  173. package/lib/service/worker/index.d.ts +11 -0
  174. package/lib/service/worker/index.js +197 -0
  175. package/lib/service/worker/listeners.d.ts +3 -0
  176. package/lib/{utils/unhandled.js → service/worker/listeners.js} +12 -16
  177. package/lib/service/{Service.d.ts → worker/runtime/Service.d.ts} +5 -5
  178. package/lib/service/{Service.js → worker/runtime/Service.js} +3 -1
  179. package/lib/service/worker/runtime/builtIn/handlers.d.ts +4 -0
  180. package/lib/service/worker/runtime/builtIn/handlers.js +34 -0
  181. package/lib/service/worker/runtime/builtIn/middlewares.d.ts +4 -0
  182. package/lib/service/worker/runtime/builtIn/middlewares.js +43 -0
  183. package/lib/service/worker/runtime/events/index.d.ts +4 -0
  184. package/lib/service/worker/runtime/events/index.js +48 -0
  185. package/lib/service/worker/runtime/events/middlewares/body.d.ts +3 -0
  186. package/lib/service/worker/runtime/events/middlewares/body.js +26 -0
  187. package/lib/service/worker/runtime/events/middlewares/context.d.ts +3 -0
  188. package/lib/service/worker/runtime/events/middlewares/context.js +23 -0
  189. package/lib/service/worker/runtime/events/router.d.ts +2 -0
  190. package/lib/service/worker/runtime/events/router.js +29 -0
  191. package/lib/service/worker/runtime/graphql/index.d.ts +6 -0
  192. package/lib/service/worker/runtime/graphql/index.js +29 -0
  193. package/lib/service/worker/runtime/graphql/middlewares/context.d.ts +2 -0
  194. package/lib/service/worker/runtime/graphql/middlewares/context.js +17 -0
  195. package/lib/service/worker/runtime/graphql/middlewares/error.js +97 -0
  196. package/lib/service/worker/runtime/graphql/middlewares/query.d.ts +3 -0
  197. package/lib/service/worker/runtime/graphql/middlewares/query.js +54 -0
  198. package/lib/service/worker/runtime/graphql/middlewares/response.js +39 -0
  199. package/lib/service/worker/runtime/graphql/middlewares/run.d.ts +2 -0
  200. package/lib/service/worker/runtime/graphql/middlewares/run.js +21 -0
  201. package/lib/service/worker/runtime/graphql/middlewares/updateSchema.d.ts +5 -0
  202. package/lib/service/worker/runtime/graphql/middlewares/updateSchema.js +30 -0
  203. package/lib/service/worker/runtime/graphql/middlewares/upload.d.ts +4 -0
  204. package/lib/service/{graphql → worker/runtime/graphql}/middlewares/upload.js +2 -1
  205. package/lib/service/worker/runtime/graphql/schema/index.d.ts +7 -0
  206. package/lib/service/worker/runtime/graphql/schema/index.js +33 -0
  207. package/lib/service/worker/runtime/graphql/schema/messagesLoaderV2.d.ts +6 -0
  208. package/lib/service/worker/runtime/graphql/schema/messagesLoaderV2.js +81 -0
  209. package/lib/service/{graphql → worker/runtime/graphql}/schema/schemaDirectives/Auth.d.ts +1 -0
  210. package/lib/service/{graphql → worker/runtime/graphql}/schema/schemaDirectives/Auth.js +17 -10
  211. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/CacheControl.d.ts +7 -0
  212. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/CacheControl.js +38 -0
  213. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Deprecated.d.ts +11 -0
  214. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Deprecated.js +62 -0
  215. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Metric.d.ts +7 -0
  216. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Metric.js +41 -0
  217. package/lib/service/{graphql → worker/runtime/graphql}/schema/schemaDirectives/Sanitize.d.ts +1 -0
  218. package/lib/service/{graphql → worker/runtime/graphql}/schema/schemaDirectives/Sanitize.js +7 -0
  219. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Settings.d.ts +6 -0
  220. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Settings.js +35 -0
  221. package/lib/service/{graphql → worker/runtime/graphql}/schema/schemaDirectives/SmartCacheDirective.d.ts +1 -0
  222. package/lib/service/{graphql → worker/runtime/graphql}/schema/schemaDirectives/SmartCacheDirective.js +9 -3
  223. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/TranslatableV2.d.ts +7 -0
  224. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/TranslatableV2.js +40 -0
  225. package/lib/service/{graphql/schema/schemaDirectives/Translatable.d.ts → worker/runtime/graphql/schema/schemaDirectives/TranslateTo.d.ts} +2 -1
  226. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/TranslateTo.js +34 -0
  227. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/index.d.ts +22 -0
  228. package/lib/service/worker/runtime/graphql/schema/schemaDirectives/index.js +37 -0
  229. package/lib/service/worker/runtime/graphql/schema/typeDefs/index.d.ts +8 -0
  230. package/lib/service/worker/runtime/graphql/schema/typeDefs/index.js +14 -0
  231. package/lib/service/{graphql → worker/runtime/graphql}/schema/typeDefs/ioUpload.js +1 -0
  232. package/lib/service/{graphql → worker/runtime/graphql}/schema/typeDefs/sanitizedString.js +8 -3
  233. package/lib/service/worker/runtime/graphql/typings.d.ts +31 -0
  234. package/lib/service/worker/runtime/graphql/utils/cacheControl.d.ts +2 -0
  235. package/lib/service/worker/runtime/graphql/utils/cacheControl.js +34 -0
  236. package/lib/service/worker/runtime/graphql/utils/error.d.ts +2 -0
  237. package/lib/service/worker/runtime/graphql/utils/error.js +78 -0
  238. package/lib/service/worker/runtime/graphql/utils/pathname.js +9 -0
  239. package/lib/service/worker/runtime/graphql/utils/translations.d.ts +14 -0
  240. package/lib/service/worker/runtime/graphql/utils/translations.js +42 -0
  241. package/lib/service/worker/runtime/http/index.d.ts +5 -0
  242. package/lib/service/worker/runtime/http/index.js +61 -0
  243. package/lib/service/worker/runtime/http/middlewares/authTokens.d.ts +3 -0
  244. package/lib/service/{http → worker/runtime/http}/middlewares/authTokens.js +1 -0
  245. package/lib/service/worker/runtime/http/middlewares/cancellationToken.d.ts +3 -0
  246. package/lib/service/{http → worker/runtime/http}/middlewares/cancellationToken.js +3 -1
  247. package/lib/service/worker/runtime/http/middlewares/clients.d.ts +4 -0
  248. package/lib/service/{http → worker/runtime/http}/middlewares/clients.js +1 -0
  249. package/lib/service/worker/runtime/http/middlewares/context.d.ts +4 -0
  250. package/lib/service/worker/runtime/http/middlewares/context.js +39 -0
  251. package/lib/service/worker/runtime/http/middlewares/error.d.ts +2 -0
  252. package/lib/service/{http → worker/runtime/http}/middlewares/error.js +29 -16
  253. package/lib/service/worker/runtime/http/middlewares/rateLimit.d.ts +6 -0
  254. package/lib/service/worker/runtime/http/middlewares/rateLimit.js +43 -0
  255. package/lib/service/{http → worker/runtime/http}/middlewares/requestStats.d.ts +3 -3
  256. package/lib/service/{http → worker/runtime/http}/middlewares/requestStats.js +1 -0
  257. package/lib/service/worker/runtime/http/middlewares/setCookie.d.ts +3 -0
  258. package/lib/service/{http → worker/runtime/http}/middlewares/setCookie.js +6 -5
  259. package/lib/service/worker/runtime/http/middlewares/settings.d.ts +9 -0
  260. package/lib/service/worker/runtime/http/middlewares/settings.js +49 -0
  261. package/lib/service/worker/runtime/http/middlewares/timings.d.ts +3 -0
  262. package/lib/service/{http → worker/runtime/http}/middlewares/timings.js +25 -11
  263. package/lib/service/worker/runtime/http/middlewares/vary.d.ts +3 -0
  264. package/lib/service/{http → worker/runtime/http}/middlewares/vary.js +4 -3
  265. package/lib/service/worker/runtime/http/router.d.ts +2 -0
  266. package/lib/service/worker/runtime/http/router.js +25 -0
  267. package/lib/service/worker/runtime/http/routes.d.ts +19 -0
  268. package/lib/service/worker/runtime/http/routes.js +16 -0
  269. package/lib/service/worker/runtime/method.d.ts +9 -0
  270. package/lib/service/{method.js → worker/runtime/method.js} +2 -1
  271. package/lib/service/worker/runtime/statusTrack.d.ts +14 -0
  272. package/lib/service/worker/runtime/statusTrack.js +43 -0
  273. package/lib/service/worker/runtime/typings.d.ts +173 -0
  274. package/lib/service/worker/runtime/utils/compose.d.ts +5 -0
  275. package/lib/service/worker/runtime/utils/compose.js +14 -0
  276. package/lib/service/worker/runtime/utils/context.d.ts +5 -0
  277. package/lib/service/worker/runtime/utils/context.js +42 -0
  278. package/lib/service/worker/runtime/utils/diff.d.ts +12 -0
  279. package/lib/service/worker/runtime/utils/diff.js +22 -0
  280. package/lib/service/worker/runtime/utils/recorder.d.ts +8 -0
  281. package/lib/service/worker/runtime/utils/recorder.js +38 -0
  282. package/lib/service/worker/runtime/utils/toArray.js +5 -0
  283. package/lib/service/worker/runtime/utils/tokenBucket.d.ts +2 -0
  284. package/lib/service/worker/runtime/utils/tokenBucket.js +17 -0
  285. package/lib/tracing/LogEvents.d.ts +31 -0
  286. package/lib/{service/graphql/utils/array.js → tracing/LogEvents.js} +1 -1
  287. package/lib/tracing/LogFields.d.ts +66 -0
  288. package/lib/tracing/LogFields.js +3 -0
  289. package/lib/tracing/Tags.d.ts +81 -0
  290. package/lib/tracing/Tags.js +8 -0
  291. package/lib/tracing/UserLandTracer.d.ts +27 -0
  292. package/lib/tracing/UserLandTracer.js +58 -0
  293. package/lib/tracing/errorReporting/ErrorReport.d.ts +31 -0
  294. package/lib/tracing/errorReporting/ErrorReport.js +71 -0
  295. package/lib/tracing/index.d.ts +9 -0
  296. package/lib/tracing/index.js +20 -0
  297. package/lib/tracing/spanReference/SpanReferenceTypes.d.ts +4 -0
  298. package/lib/tracing/spanReference/SpanReferenceTypes.js +8 -0
  299. package/lib/tracing/spanReference/createSpanReference.d.ts +3 -0
  300. package/lib/tracing/spanReference/createSpanReference.js +9 -0
  301. package/lib/tracing/utils.d.ts +13 -0
  302. package/lib/tracing/utils.js +42 -0
  303. package/lib/utils/MineWinsConflictsResolver.d.ts +7 -5
  304. package/lib/utils/MineWinsConflictsResolver.js +40 -22
  305. package/lib/utils/app.d.ts +3 -1
  306. package/lib/utils/app.js +40 -21
  307. package/lib/utils/appsStaleIfError.d.ts +2 -1
  308. package/lib/utils/appsStaleIfError.js +33 -12
  309. package/lib/utils/billingOptions.d.ts +36 -3
  310. package/lib/utils/billingOptions.js +9 -3
  311. package/lib/utils/binding.d.ts +3 -3
  312. package/lib/utils/binding.js +5 -2
  313. package/lib/utils/cancel.d.ts +2 -2
  314. package/lib/utils/cancel.js +3 -1
  315. package/lib/utils/conflicts.mock.d.ts +17 -0
  316. package/lib/utils/conflicts.mock.js +28 -0
  317. package/lib/utils/domain.js +2 -1
  318. package/lib/utils/error.js +6 -4
  319. package/lib/utils/index.js +23 -12
  320. package/lib/utils/json.js +1 -0
  321. package/lib/utils/log.d.ts +1 -3
  322. package/lib/utils/log.js +6 -4
  323. package/lib/utils/message.js +11 -4
  324. package/lib/utils/renameBy.js +3 -1
  325. package/lib/utils/retry.js +10 -7
  326. package/lib/utils/status.js +3 -1
  327. package/lib/utils/tenant.d.ts +3 -3
  328. package/lib/utils/tenant.js +5 -2
  329. package/lib/utils/throwOnGraphQLErrors.js +1 -0
  330. package/lib/utils/time.d.ts +7 -7
  331. package/lib/utils/time.js +29 -12
  332. package/package.json +3 -3
  333. package/lib/HttpClient/IOClient.d.ts +0 -13
  334. package/lib/HttpClient/IOClient.js +0 -14
  335. package/lib/HttpClient/factories/index.d.ts +0 -8
  336. package/lib/HttpClient/factories/index.js +0 -31
  337. package/lib/HttpClient/middlewares/request.d.ts +0 -10
  338. package/lib/HttpClient/middlewares/request.js +0 -87
  339. package/lib/IODataSource.d.ts +0 -27
  340. package/lib/IODataSource.js +0 -46
  341. package/lib/clients/Apps.d.ts +0 -84
  342. package/lib/clients/Apps.js +0 -326
  343. package/lib/clients/Assets.d.ts +0 -21
  344. package/lib/clients/Assets.js +0 -110
  345. package/lib/clients/Billing.d.ts +0 -11
  346. package/lib/clients/BillingMetrics.d.ts +0 -12
  347. package/lib/clients/BillingMetrics.js +0 -10
  348. package/lib/clients/Events.d.ts +0 -6
  349. package/lib/clients/Events.js +0 -19
  350. package/lib/clients/Housekeeper.d.ts +0 -11
  351. package/lib/clients/Housekeeper.js +0 -24
  352. package/lib/clients/ID.d.ts +0 -22
  353. package/lib/clients/ID.js +0 -48
  354. package/lib/clients/LicenseManager.d.ts +0 -6
  355. package/lib/clients/LicenseManager.js +0 -43
  356. package/lib/clients/Logger.d.ts +0 -27
  357. package/lib/clients/Logger.js +0 -32
  358. package/lib/clients/Messages.d.ts +0 -18
  359. package/lib/clients/Messages.js +0 -20
  360. package/lib/clients/MessagesGraphQL.d.ts +0 -63
  361. package/lib/clients/MessagesGraphQL.js +0 -50
  362. package/lib/clients/Metadata.d.ts +0 -25
  363. package/lib/clients/Metadata.js +0 -53
  364. package/lib/clients/Registry.d.ts +0 -61
  365. package/lib/clients/Registry.js +0 -147
  366. package/lib/clients/Router.d.ts +0 -33
  367. package/lib/clients/Router.js +0 -50
  368. package/lib/clients/Segment.js +0 -69
  369. package/lib/clients/Settings.js +0 -44
  370. package/lib/clients/Sphinx.d.ts +0 -12
  371. package/lib/clients/Sphinx.js +0 -19
  372. package/lib/clients/Tenant.js +0 -13
  373. package/lib/clients/VBase.d.ts +0 -57
  374. package/lib/clients/VBase.js +0 -116
  375. package/lib/clients/Workspaces.d.ts +0 -17
  376. package/lib/clients/Workspaces.js +0 -38
  377. package/lib/service/Runtime.d.ts +0 -18
  378. package/lib/service/Runtime.js +0 -57
  379. package/lib/service/events/index.d.ts +0 -3
  380. package/lib/service/events/index.js +0 -21
  381. package/lib/service/graphql/index.d.ts +0 -7
  382. package/lib/service/graphql/index.js +0 -33
  383. package/lib/service/graphql/middlewares/error.js +0 -107
  384. package/lib/service/graphql/middlewares/formatters.d.ts +0 -2
  385. package/lib/service/graphql/middlewares/formatters.js +0 -64
  386. package/lib/service/graphql/middlewares/query.d.ts +0 -2
  387. package/lib/service/graphql/middlewares/query.js +0 -32
  388. package/lib/service/graphql/middlewares/response.js +0 -36
  389. package/lib/service/graphql/middlewares/run.d.ts +0 -4
  390. package/lib/service/graphql/middlewares/run.js +0 -55
  391. package/lib/service/graphql/middlewares/schema.d.ts +0 -2
  392. package/lib/service/graphql/middlewares/schema.js +0 -8
  393. package/lib/service/graphql/middlewares/timings.d.ts +0 -2
  394. package/lib/service/graphql/middlewares/timings.js +0 -10
  395. package/lib/service/graphql/middlewares/upload.d.ts +0 -7
  396. package/lib/service/graphql/schema/index.d.ts +0 -3
  397. package/lib/service/graphql/schema/index.js +0 -66
  398. package/lib/service/graphql/schema/messagesLoader.d.ts +0 -4
  399. package/lib/service/graphql/schema/messagesLoader.js +0 -41
  400. package/lib/service/graphql/schema/messagesLoaderV2.d.ts +0 -5
  401. package/lib/service/graphql/schema/messagesLoaderV2.js +0 -44
  402. package/lib/service/graphql/schema/schemaDirectives/Translatable.js +0 -54
  403. package/lib/service/graphql/schema/schemaDirectives/TranslatableV2.d.ts +0 -13
  404. package/lib/service/graphql/schema/schemaDirectives/TranslatableV2.js +0 -67
  405. package/lib/service/graphql/schema/schemaDirectives/index.d.ts +0 -13
  406. package/lib/service/graphql/schema/schemaDirectives/index.js +0 -17
  407. package/lib/service/graphql/schema/typeDefs/index.d.ts +0 -16
  408. package/lib/service/graphql/schema/typeDefs/index.js +0 -21
  409. package/lib/service/graphql/schema/typeDefs/ioMessage.d.ts +0 -8
  410. package/lib/service/graphql/schema/typeDefs/ioMessage.js +0 -33
  411. package/lib/service/graphql/typings.d.ts +0 -21
  412. package/lib/service/graphql/utils/cacheControl.d.ts +0 -6
  413. package/lib/service/graphql/utils/cacheControl.js +0 -38
  414. package/lib/service/graphql/utils/maxAgeEnum.d.ts +0 -6
  415. package/lib/service/graphql/utils/maxAgeEnum.js +0 -17
  416. package/lib/service/graphql/utils/pathname.js +0 -7
  417. package/lib/service/http/index.d.ts +0 -3
  418. package/lib/service/http/index.js +0 -18
  419. package/lib/service/http/middlewares/authTokens.d.ts +0 -3
  420. package/lib/service/http/middlewares/cancellationToken.d.ts +0 -3
  421. package/lib/service/http/middlewares/clients.d.ts +0 -4
  422. package/lib/service/http/middlewares/error.d.ts +0 -3
  423. package/lib/service/http/middlewares/setCookie.d.ts +0 -3
  424. package/lib/service/http/middlewares/timings.d.ts +0 -3
  425. package/lib/service/http/middlewares/vary.d.ts +0 -3
  426. package/lib/service/method.d.ts +0 -9
  427. package/lib/service/typings.d.ts +0 -139
  428. package/lib/service/utils/compose.d.ts +0 -4
  429. package/lib/service/utils/compose.js +0 -11
  430. package/lib/utils/MineWinsConflictsResolver.test.d.ts +0 -1
  431. package/lib/utils/MineWinsConflictsResolver.test.js +0 -134
  432. package/lib/utils/unhandled.d.ts +0 -1
  433. /package/lib/service/{graphql → worker/runtime/graphql}/middlewares/error.d.ts +0 -0
  434. /package/lib/service/{graphql → worker/runtime/graphql}/middlewares/response.d.ts +0 -0
  435. /package/lib/service/{graphql → worker/runtime/graphql}/schema/typeDefs/ioUpload.d.ts +0 -0
  436. /package/lib/service/{graphql → worker/runtime/graphql}/schema/typeDefs/sanitizedString.d.ts +0 -0
  437. /package/lib/service/{graphql → worker/runtime/graphql}/typings.js +0 -0
  438. /package/lib/service/{graphql → worker/runtime/graphql}/utils/pathname.d.ts +0 -0
  439. /package/lib/service/{typings.js → worker/runtime/typings.js} +0 -0
  440. /package/lib/service/{graphql/utils/array.d.ts → worker/runtime/utils/toArray.d.ts} +0 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vtex/api",
3
- "version": "6.48.1-beta",
3
+ "version": "6.48.1-beta.2",
4
4
  "description": "VTEX I/O API client",
5
5
  "main": "lib/index.js",
6
6
  "typings": "lib/index.d.ts",
@@ -121,7 +121,7 @@
121
121
  "tslint-config-vtex": "^2.1.0",
122
122
  "tslint-eslint-rules": "^5.4.0",
123
123
  "typemoq": "^2.1.0",
124
- "typescript": "^3.8.3",
125
- "typescript-json-schema": "^0.40.0"
124
+ "typescript": "4.9.5",
125
+ "typescript-json-schema": "^0.65.1"
126
126
  }
127
127
  }
@@ -1,13 +0,0 @@
1
- import { IOContext } from '../service/typings';
2
- import { HttpClient } from './HttpClient';
3
- import { InstanceOptions } from './typings';
4
- export declare type IOClientConstructor = new (context: IOContext, options?: InstanceOptions) => IOClient;
5
- /**
6
- * A client that can be instantiated by the Service runtime layer.
7
- */
8
- export declare class IOClient {
9
- protected context: IOContext;
10
- protected options?: InstanceOptions | undefined;
11
- protected http: HttpClient;
12
- constructor(context: IOContext, options?: InstanceOptions | undefined);
13
- }
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const HttpClient_1 = require("./HttpClient");
4
- /**
5
- * A client that can be instantiated by the Service runtime layer.
6
- */
7
- class IOClient {
8
- constructor(context, options) {
9
- this.context = context;
10
- this.options = options;
11
- this.http = new HttpClient_1.HttpClient(Object.assign({ name: this.constructor.name }, context, options, { metrics: options && options.metrics }));
12
- }
13
- }
14
- exports.IOClient = IOClient;
@@ -1,8 +0,0 @@
1
- import { IOContext } from '../../service/typings';
2
- import { HttpClient } from '../HttpClient';
3
- import { InstanceOptions } from '../typings';
4
- export declare const rootURL: (service: string, { region }: IOContext, { baseURL }: InstanceOptions) => string;
5
- export declare const workspaceURL: (service: string, context: IOContext, opts: InstanceOptions) => string;
6
- export declare const forWorkspace: (service: string, context: IOContext, opts: InstanceOptions) => HttpClient;
7
- export declare const forRoot: (service: string, context: IOContext, opts: InstanceOptions) => HttpClient;
8
- export declare const forExternal: (baseURL: string, context: IOContext, opts: InstanceOptions) => HttpClient;
@@ -1,31 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const HttpClient_1 = require("../HttpClient");
4
- const typings_1 = require("../typings");
5
- exports.rootURL = (service, { region }, { baseURL }) => {
6
- if (baseURL) {
7
- return 'http://' + baseURL;
8
- }
9
- if (region) {
10
- return `http://${service}.${region}.vtex.io`;
11
- }
12
- throw new Error('Missing required: should specify either {region} or {baseURL}');
13
- };
14
- exports.workspaceURL = (service, context, opts) => {
15
- const { account, workspace } = context;
16
- if (!account || !workspace) {
17
- throw new Error('Missing required arguments: {account, workspace}');
18
- }
19
- return exports.rootURL(service, context, opts) + `/${account}/${workspace}`;
20
- };
21
- exports.forWorkspace = (service, context, opts) => {
22
- const baseURL = exports.workspaceURL(service, context, opts);
23
- return new HttpClient_1.HttpClient(Object.assign({}, context, opts, { authType: typings_1.AuthType.bearer, baseURL }));
24
- };
25
- exports.forRoot = (service, context, opts) => {
26
- const baseURL = exports.rootURL(service, context, opts);
27
- return new HttpClient_1.HttpClient(Object.assign({}, context, opts, { authType: typings_1.AuthType.bearer, baseURL }));
28
- };
29
- exports.forExternal = (baseURL, context, opts) => {
30
- return new HttpClient_1.HttpClient(Object.assign({}, context, opts, { baseURL }));
31
- };
@@ -1,10 +0,0 @@
1
- import { Limit } from 'p-limit';
2
- import { MiddlewareContext } from '../typings';
3
- export declare const defaultsMiddleware: (baseURL: string | undefined, rawHeaders: Record<string, string>, params: Record<string, string> | undefined, timeout: number, retries?: number | undefined, verbose?: boolean | undefined) => (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
4
- export declare const routerCacheMiddleware: (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
5
- export declare const requestMiddleware: (limit?: Limit | undefined) => (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
6
- export declare function httpAgentStats(): {
7
- freeSockets: number;
8
- pendingRequests: number;
9
- sockets: number;
10
- };
@@ -1,87 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- var __importStar = (this && this.__importStar) || function (mod) {
6
- if (mod && mod.__esModule) return mod;
7
- var result = {};
8
- if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
9
- result["default"] = mod;
10
- return result;
11
- };
12
- Object.defineProperty(exports, "__esModule", { value: true });
13
- const agentkeepalive_1 = __importDefault(require("agentkeepalive"));
14
- const axios_1 = __importDefault(require("axios"));
15
- const axios_retry_1 = __importStar(require("axios-retry"));
16
- const qs_1 = require("qs");
17
- const ramda_1 = require("ramda");
18
- const renameBy_1 = require("../../utils/renameBy");
19
- const retry_1 = require("../../utils/retry");
20
- const httpAgent = new agentkeepalive_1.default({
21
- freeSocketTimeout: 30 * 1000,
22
- keepAlive: true,
23
- maxFreeSockets: 256,
24
- socketActiveTTL: 120 * 1000,
25
- });
26
- const http = axios_1.default.create({
27
- httpAgent,
28
- });
29
- axios_retry_1.default(http, {
30
- retries: 0,
31
- retryCondition: retry_1.isAbortedOrNetworkErrorOrRouterTimeout,
32
- retryDelay: axios_retry_1.exponentialDelay,
33
- shouldResetTimeout: true,
34
- });
35
- const paramsSerializer = (params) => {
36
- return qs_1.stringify(params, { arrayFormat: 'repeat' });
37
- };
38
- exports.defaultsMiddleware = (baseURL, rawHeaders, params, timeout, retries, verbose) => {
39
- const countByMetric = {};
40
- const headers = renameBy_1.renameBy(ramda_1.toLower, rawHeaders);
41
- return async (ctx, next) => {
42
- ctx.config = Object.assign({ 'axios-retry': retries ? { retries } : undefined, baseURL, maxRedirects: 0, timeout, validateStatus: status => (status >= 200 && status < 300), verbose }, ctx.config, { headers: Object.assign({}, headers, renameBy_1.renameBy(ramda_1.toLower, ctx.config.headers)), params: Object.assign({}, params, ctx.config.params), paramsSerializer });
43
- if (ctx.config.verbose && ctx.config.metric) {
44
- const current = countByMetric[ctx.config.metric];
45
- countByMetric[ctx.config.metric] = (current || 0) + 1;
46
- ctx.config.count = countByMetric[ctx.config.metric];
47
- ctx.config.label = `${ctx.config.metric}#${ctx.config.count}`;
48
- }
49
- await next();
50
- };
51
- };
52
- const ROUTER_CACHE_KEY = 'x-router-cache';
53
- const ROUTER_CACHE_HIT = 'HIT';
54
- const ROUTER_CACHE_REVALIDATED = 'REVALIDATED';
55
- const ROUTER_CACHE_KEY_PATH = ['response', 'headers', ROUTER_CACHE_KEY];
56
- const ROUTER_RESPONSE_STATUS_PATH = ['response', 'status'];
57
- exports.routerCacheMiddleware = async (ctx, next) => {
58
- await next();
59
- const routerCacheHit = ramda_1.path(ROUTER_CACHE_KEY_PATH, ctx);
60
- const status = ramda_1.path(ROUTER_RESPONSE_STATUS_PATH, ctx);
61
- if (routerCacheHit === ROUTER_CACHE_HIT || (routerCacheHit === ROUTER_CACHE_REVALIDATED && status !== 304)) {
62
- ctx.cacheHit = Object.assign({ memory: 0, revalidated: 0 }, ctx.cacheHit, { router: 1 });
63
- }
64
- };
65
- exports.requestMiddleware = (limit) => async (ctx, next) => {
66
- const makeRequest = () => http.request(ctx.config);
67
- ctx.response = await (limit ? limit(makeRequest) : makeRequest());
68
- };
69
- function count(obj) {
70
- try {
71
- return Object.values(obj).reduce((acc, val) => acc += val.length, 0);
72
- }
73
- catch (_) {
74
- return 0;
75
- }
76
- }
77
- function httpAgentStats() {
78
- const sockets = count(httpAgent.sockets);
79
- const freeSockets = count(httpAgent.freeSockets);
80
- const pendingRequests = count(httpAgent.requests);
81
- return {
82
- freeSockets,
83
- pendingRequests,
84
- sockets,
85
- };
86
- }
87
- exports.httpAgentStats = httpAgentStats;
@@ -1,27 +0,0 @@
1
- import { DataSource, DataSourceConfig } from 'apollo-datasource';
2
- import { HttpClient, InstanceOptions } from './HttpClient';
3
- import { IOContext, ServiceContext } from './service/typings';
4
- interface HttpClientFactoryOptions {
5
- service: string | void;
6
- context: IOContext | void;
7
- options: InstanceOptions | void;
8
- }
9
- export declare type HttpClientFactory = (opts: HttpClientFactoryOptions) => HttpClient | void;
10
- /**
11
- * @deprecated Extend one of the subclasses of IOClient instead.
12
- */
13
- export declare abstract class IODataSource extends DataSource<ServiceContext> {
14
- protected context?: IOContext | undefined;
15
- private options;
16
- protected abstract httpClientFactory: HttpClientFactory;
17
- protected service: string | void;
18
- private httpClient;
19
- private initialized;
20
- constructor(context?: IOContext | undefined, options?: InstanceOptions);
21
- initialize(config: DataSourceConfig<ServiceContext>): void;
22
- readonly http: HttpClient;
23
- }
24
- export declare const forWorkspace: HttpClientFactory;
25
- export declare const forRoot: HttpClientFactory;
26
- export declare const forExternal: HttpClientFactory;
27
- export {};
@@ -1,46 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const apollo_datasource_1 = require("apollo-datasource");
4
- const HttpClient_1 = require("./HttpClient");
5
- /**
6
- * @deprecated Extend one of the subclasses of IOClient instead.
7
- */
8
- class IODataSource extends apollo_datasource_1.DataSource {
9
- constructor(context, options = {}) {
10
- super();
11
- this.context = context;
12
- this.options = options;
13
- this.service = undefined;
14
- this.httpClient = undefined;
15
- this.initialized = false;
16
- }
17
- initialize(config) {
18
- const { context: { vtex: context }, cache: cacheStorage } = config;
19
- this.context = context;
20
- this.httpClient = this.httpClientFactory({
21
- context,
22
- options: Object.assign({ cacheStorage }, this.options),
23
- service: this.service,
24
- });
25
- this.initialized = true;
26
- }
27
- get http() {
28
- if (!this.initialized) {
29
- this.initialize({ context: { vtex: this.context } });
30
- }
31
- if (this.httpClient) {
32
- return this.httpClient;
33
- }
34
- throw new Error('IO Datasource was not initialized nor constructed with a context');
35
- }
36
- }
37
- exports.IODataSource = IODataSource;
38
- exports.forWorkspace = ({ context, service, options }) => (context && service)
39
- ? HttpClient_1.HttpClient.forWorkspace(service, context, options || {})
40
- : undefined;
41
- exports.forRoot = ({ context, service, options }) => (context && service)
42
- ? HttpClient_1.HttpClient.forRoot(service, context, options || {})
43
- : undefined;
44
- exports.forExternal = ({ context, service, options }) => (context && service)
45
- ? HttpClient_1.HttpClient.forExternal(service, context, options || {})
46
- : undefined;
@@ -1,84 +0,0 @@
1
- /// <reference types="node" />
2
- import { IncomingMessage } from 'http';
3
- import { Readable, Writable } from 'stream';
4
- import { ZlibOptions } from 'zlib';
5
- import { InfraClient, InstanceOptions } from '../HttpClient';
6
- import { AppBundleLinked, AppFilesList, AppManifest } from '../responses';
7
- import { IOContext } from '../service/typings';
8
- export declare class Apps extends InfraClient {
9
- private _routes;
10
- private diskCache;
11
- private memoryCache;
12
- private readonly routes;
13
- constructor(context: IOContext, options?: InstanceOptions);
14
- installApp: (descriptor: string) => Promise<void>;
15
- uninstallApp: (app: string) => Promise<import("..").IOResponse<void>>;
16
- acknowledgeApp: (app: string, service: string) => Promise<void>;
17
- link: (app: string, files: Change[], { zlib }?: ZipOptions) => Promise<AppBundleLinked>;
18
- patch: (app: string, changes: Change[], { zlib }?: ZipOptions) => Promise<void>;
19
- unlink: (app: string) => Promise<import("..").IOResponse<void>>;
20
- unlinkAll: () => Promise<import("..").IOResponse<void>>;
21
- saveAppSettings: (app: string, settings: any) => Promise<void>;
22
- listApps: ({ oldVersion, since, service }?: ListAppsOptions) => Promise<AppsList>;
23
- listAppFiles: (app: string, { prefix, nextMarker }?: ListFilesOptions) => Promise<AppFilesList>;
24
- listLinks: () => Promise<string[]>;
25
- getAppFile: (app: string, path: string, staleIfError?: boolean | undefined) => Promise<{
26
- data: Buffer;
27
- headers: any;
28
- }>;
29
- getAppJSON: <T extends object | null>(app: string, path: string, nullIfNotFound?: boolean | undefined) => Promise<T>;
30
- getLinkedAppByWorkspaceJSON: <T extends object | null>(app: string, path: string, nullIfNotFound?: boolean | undefined) => Promise<T>;
31
- getAppFileStream: (app: string, path: string) => Promise<IncomingMessage>;
32
- getApp: (app: string) => Promise<AppManifest>;
33
- getAppSettings: (app: string) => Promise<any>;
34
- getAllAppsSettings: (listAppsOptions?: ListAppsOptions) => Promise<AppsSettings>;
35
- getAppBundle: (app: string, bundlePath: string, generatePackageJson: boolean) => Promise<Readable>;
36
- unpackAppBundle: (app: string, bundlePath: string, unpackPath: string, generatePackageJson: boolean) => Promise<Writable>;
37
- getAppsMetaInfos: (filter?: string | undefined, staleWhileRevalidate?: boolean) => Promise<AppMetaInfo[]>;
38
- getDependencies: (filter?: string) => Promise<Record<string, string[]>>;
39
- updateDependencies: () => Promise<Record<string, string[]>>;
40
- updateDependency: (name: string, version: string, registry: string) => Promise<void>;
41
- resolveDependencies: (apps: string[], registries: string[], filter?: string) => Promise<any>;
42
- resolveDependenciesWithManifest: (manifest: AppManifest, filter?: string) => Promise<Record<string, string[]>>;
43
- private installRuntime;
44
- }
45
- interface ZipOptions {
46
- zlib?: ZlibOptions;
47
- }
48
- export interface AppMetaInfo {
49
- id: string;
50
- settingsSchema?: Record<string, any>;
51
- _resolvedDependencies: Record<string, string>;
52
- _isRoot: boolean;
53
- _buildFeatures: Record<string, string[]>;
54
- }
55
- export interface WorkspaceMetaInfo {
56
- apps: AppMetaInfo[];
57
- }
58
- export interface AppsListItem {
59
- app: string;
60
- id: string;
61
- location: string;
62
- }
63
- export interface AppsList {
64
- data: AppsListItem[];
65
- }
66
- export interface Change {
67
- path: string;
68
- content: string | Readable | Buffer;
69
- }
70
- export interface ListAppsOptions {
71
- oldVersion?: string;
72
- context?: string[];
73
- since?: string;
74
- service?: string;
75
- }
76
- export interface ListFilesOptions {
77
- prefix?: string;
78
- context?: string[];
79
- nextMarker?: string;
80
- }
81
- export interface AppsSettings {
82
- [app: string]: any;
83
- }
84
- export {};
@@ -1,326 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- const archiver_1 = __importDefault(require("archiver"));
7
- const ramda_1 = require("ramda");
8
- const tar_fs_1 = require("tar-fs");
9
- const zlib_1 = require("zlib");
10
- const HttpClient_1 = require("../HttpClient");
11
- const utils_1 = require("../utils");
12
- const appsStaleIfError_1 = require("../utils/appsStaleIfError");
13
- const createRoutes = ({ account, workspace }) => {
14
- const routes = {
15
- Acknowledge: (app, service) => `${routes.App(app)}/acknowledge/${service}`,
16
- App: (app) => `${routes.Apps()}/${app}`,
17
- AppBundle: (locator, path) => `${routes.AppOrRegistry(locator)}/bundle/${path}`,
18
- AppOrRegistry: ({ name, version, build }) => build
19
- ? `${routes.Apps()}/${name}@${version}+${build}`
20
- : `${routes.Registry()}/${name}/${version}`,
21
- Apps: () => `${routes.Workspace}/apps`,
22
- Dependencies: () => `${routes.Workspace}/dependencies`,
23
- File: (locator, path) => `${routes.Files(locator)}/${path}`,
24
- Files: (locator) => `${routes.AppOrRegistry(locator)}/files`,
25
- Link: (app) => `${routes.Workspace}/v2/links/${app}`,
26
- LinkedAppFile: (app, path) => `${routes.Workspace}/apps/${app}/files/${path}`,
27
- Links: () => `${routes.Workspace}/links`,
28
- Master: `/${account}/master`,
29
- Meta: () => `${routes.Workspace}/v2/apps`,
30
- Registry: () => `${routes.Master}/registry`,
31
- ResolveDependencies: () => `${routes.Workspace}/dependencies/_resolve`,
32
- ResolveDependenciesWithManifest: () => `${routes.Workspace}/v2/apps/_resolve`,
33
- Settings: (app) => `${routes.App(app)}/settings`,
34
- Unlink: (app) => `${routes.Links()}/${app}`,
35
- Workspace: `/${account}/${workspace}`,
36
- };
37
- return routes;
38
- };
39
- const getVendorAndName = ({ id }) => utils_1.removeVersionFromAppId(id);
40
- const notFound = (e) => {
41
- if (e.response && e.response.status === 404) {
42
- return {};
43
- }
44
- throw e;
45
- };
46
- const zipObj = (keys, values) => {
47
- let idx = 0;
48
- const len = Math.min(keys.length, values.length);
49
- const out = {};
50
- while (idx < len) {
51
- out[keys[idx]] = values[idx];
52
- idx += 1;
53
- }
54
- return out;
55
- };
56
- const workspaceFields = [
57
- '_resolvedDependencies',
58
- 'settingsSchema',
59
- '_isRoot',
60
- '_buildFeatures',
61
- ].join(',');
62
- class Apps extends HttpClient_1.InfraClient {
63
- constructor(context, options) {
64
- super('apps@0.x', context, options, true);
65
- this.installApp = (descriptor) => {
66
- if (descriptor.startsWith('infra:service-')) {
67
- return this.installRuntime(descriptor);
68
- }
69
- return this.http.post(this.routes.Apps(), { id: descriptor }, { metric: 'apps-install' });
70
- };
71
- this.uninstallApp = (app) => {
72
- return this.http.delete(this.routes.App(app), { metric: 'apps-uninstall' });
73
- };
74
- this.acknowledgeApp = (app, service) => {
75
- return this.http.put(this.routes.Acknowledge(app, service), null, { metric: 'apps-ack' });
76
- };
77
- this.link = async (app, files, { zlib } = {}) => {
78
- if (!(files[0] && files[0].path)) {
79
- throw new Error('Argument files must be an array of {path, content}, where content can be a String, a Buffer or a ReadableStream.');
80
- }
81
- const emptyChanges = files.filter(file => !file.content);
82
- if (emptyChanges.length > 0) {
83
- throw new Error(`Missing content for paths: ${emptyChanges.map(e => e.path).join('; ')}`);
84
- }
85
- const indexOfManifest = files.findIndex(({ path }) => path === 'manifest.json');
86
- if (indexOfManifest === -1) {
87
- throw new Error('No manifest.json file found in files.');
88
- }
89
- const zip = archiver_1.default('zip', { zlib });
90
- // Throw stream errors so they reject the promise chain.
91
- zip.on('error', (e) => {
92
- throw e;
93
- });
94
- const request = this.http.put(this.routes.Link(app), zip, {
95
- headers: { 'Content-Type': 'application/zip' },
96
- metric: 'apps-link',
97
- });
98
- files.forEach(({ content, path }) => zip.append(content, { name: path }));
99
- const finalize = zip.finalize();
100
- try {
101
- const [response] = await Promise.all([request, finalize]);
102
- response.bundleSize = zip.pointer();
103
- return response;
104
- }
105
- catch (e) {
106
- e.bundleSize = zip.pointer();
107
- throw e;
108
- }
109
- };
110
- this.patch = async (app, changes, { zlib } = {}) => {
111
- if (!(changes[0] && changes[0].path)) {
112
- throw new Error('Argument changes must be an array of {path, content}, where content can be a String, a Buffer or a ReadableStream.');
113
- }
114
- const files = changes.filter(change => !!change.content);
115
- const deletedFiles = changes
116
- .filter(change => !change.content)
117
- .map(change => change.path)
118
- .join(':');
119
- const zip = archiver_1.default('zip', { zlib });
120
- // Throw stream errors so they reject the promise chain.
121
- zip.on('error', (e) => {
122
- throw e;
123
- });
124
- const request = this.http.patch(this.routes.Link(app), zip, {
125
- headers: { 'Content-Type': 'application/zip' },
126
- metric: 'apps-patch',
127
- params: { deletedFiles },
128
- });
129
- files.forEach(({ content, path }) => zip.append(content, { name: path }));
130
- const finalize = zip.finalize();
131
- const [response] = await Promise.all([request, finalize]);
132
- return response;
133
- };
134
- this.unlink = (app) => {
135
- return this.http.delete(this.routes.Unlink(app));
136
- };
137
- this.unlinkAll = () => {
138
- return this.http.delete(this.routes.Links());
139
- };
140
- this.saveAppSettings = (app, settings) => {
141
- const headers = { 'Content-Type': 'application/json' };
142
- const metric = 'apps-save';
143
- return this.http.put(this.routes.Settings(app), settings, { headers, metric });
144
- };
145
- this.listApps = ({ oldVersion, since, service } = {}) => {
146
- const params = {
147
- oldVersion,
148
- service,
149
- since,
150
- };
151
- const metric = 'apps-list';
152
- const inflightKey = HttpClient_1.inflightUrlWithQuery;
153
- return this.http.get(this.routes.Apps(), { params, metric, inflightKey });
154
- };
155
- this.listAppFiles = (app, { prefix, nextMarker } = {}) => {
156
- const locator = utils_1.parseAppId(app);
157
- const linked = !!locator.build;
158
- const params = {
159
- marker: nextMarker,
160
- prefix,
161
- };
162
- const metric = linked ? 'apps-list-files' : 'registry-list-files';
163
- const inflightKey = HttpClient_1.inflightUrlWithQuery;
164
- return this.http.get(this.routes.Files(locator), { params, metric, inflightKey });
165
- };
166
- this.listLinks = () => {
167
- const inflightKey = HttpClient_1.inflightURL;
168
- return this.http.get(this.routes.Links(), { metric: 'apps-list-links', inflightKey });
169
- };
170
- this.getAppFile = (app, path, staleIfError) => {
171
- const { logger } = this.context;
172
- const locator = utils_1.parseAppId(app);
173
- const linked = !!locator.build;
174
- const inflightKey = HttpClient_1.inflightURL;
175
- if (staleIfError && this.memoryCache) {
176
- appsStaleIfError_1.saveVersion(app, this.memoryCache);
177
- }
178
- try {
179
- return this.http.getBuffer(this.routes.File(locator, path), {
180
- cacheable: linked ? HttpClient_1.CacheType.Memory : HttpClient_1.CacheType.Disk,
181
- inflightKey,
182
- metric: linked ? 'apps-get-file' : 'registry-get-file',
183
- });
184
- }
185
- catch (error) {
186
- logger.error({ error, message: 'getAppFile failed', app, path });
187
- if (staleIfError && this.memoryCache) {
188
- return appsStaleIfError_1.getFallbackFile(app, path, this.memoryCache, this);
189
- }
190
- throw error;
191
- }
192
- };
193
- this.getAppJSON = (app, path, nullIfNotFound) => {
194
- const locator = utils_1.parseAppId(app);
195
- const linked = !!locator.build;
196
- const inflightKey = HttpClient_1.inflightURL;
197
- return this.http.get(this.routes.File(locator, path), {
198
- cacheable: linked ? HttpClient_1.CacheType.Memory : HttpClient_1.CacheType.Any,
199
- inflightKey,
200
- metric: linked ? 'apps-get-json' : 'registry-get-json',
201
- nullIfNotFound,
202
- });
203
- };
204
- this.getLinkedAppByWorkspaceJSON = (app, path, nullIfNotFound) => {
205
- const inflightKey = HttpClient_1.inflightURL;
206
- return this.http.get(this.routes.LinkedAppFile(app, path), {
207
- cacheable: HttpClient_1.CacheType.Memory,
208
- inflightKey,
209
- metric: 'apps-linked-app-get-json',
210
- nullIfNotFound,
211
- });
212
- };
213
- this.getAppFileStream = (app, path) => {
214
- const locator = utils_1.parseAppId(app);
215
- const metric = locator.build ? 'apps-get-file-s' : 'registry-get-file-s';
216
- return this.http.getStream(this.routes.File(locator, path), { metric });
217
- };
218
- this.getApp = (app) => {
219
- const metric = 'apps-get-app';
220
- const inflightKey = HttpClient_1.inflightURL;
221
- return this.http.get(this.routes.App(app), { metric, inflightKey });
222
- };
223
- this.getAppSettings = (app) => {
224
- const inflightKey = HttpClient_1.inflightURL;
225
- const metric = 'apps-get-settings';
226
- return this.http.get(this.routes.Settings(app), { inflightKey, metric });
227
- };
228
- this.getAllAppsSettings = (listAppsOptions = {}) => {
229
- return this.listApps(listAppsOptions).then(({ data: installedApps }) => {
230
- const names = installedApps.map(getVendorAndName);
231
- const settingsPromises = names.map(vendorAndName => this.getAppSettings(vendorAndName).catch(notFound));
232
- return Promise.all(settingsPromises).then((settings) => {
233
- return zipObj(names, settings);
234
- });
235
- });
236
- };
237
- this.getAppBundle = (app, bundlePath, generatePackageJson) => {
238
- const locator = utils_1.parseAppId(app);
239
- const params = generatePackageJson && { _packageJSONEngine: 'npm', _packageJSONFilter: 'vtex.render-builder@x' };
240
- const metric = locator.build ? 'apps-get-bundle' : 'registry-get-bundle';
241
- return this.http.getStream(this.routes.AppBundle(locator, bundlePath), {
242
- headers: {
243
- Accept: 'application/x-gzip',
244
- 'Accept-Encoding': 'gzip',
245
- },
246
- metric,
247
- params,
248
- });
249
- };
250
- this.unpackAppBundle = (app, bundlePath, unpackPath, generatePackageJson) => {
251
- return this.getAppBundle(app, bundlePath, generatePackageJson)
252
- .then(stream => stream
253
- .pipe(zlib_1.createGunzip())
254
- .pipe(tar_fs_1.extract(unpackPath)));
255
- };
256
- this.getAppsMetaInfos = async (filter, staleWhileRevalidate = true) => {
257
- const { account, production } = this.context;
258
- const metric = 'get-apps-meta';
259
- const inflightKey = HttpClient_1.inflightURL;
260
- const key = appsStaleIfError_1.getMetaInfoKey(account);
261
- const cachedResponse = this.diskCache && await this.diskCache.get(key);
262
- if (cachedResponse && this.context.recorder) {
263
- this.context.recorder(cachedResponse.headers);
264
- }
265
- const metaInfoPromise = this.http.getRaw(this.routes.Meta(), { params: { fields: workspaceFields }, metric, inflightKey })
266
- .then((response) => {
267
- const { data, headers: responseHeaders } = response;
268
- if (this.diskCache) {
269
- this.diskCache.set(key, {
270
- appsMetaInfo: data.apps || [],
271
- headers: responseHeaders,
272
- });
273
- }
274
- return response;
275
- });
276
- const useCachedResponse = cachedResponse && production && staleWhileRevalidate;
277
- const appsMetaInfo = useCachedResponse
278
- ? cachedResponse.appsMetaInfo
279
- : await metaInfoPromise.then(response => response.data.apps);
280
- if (filter) {
281
- return appsMetaInfo.filter(appMeta => !!ramda_1.path(['_resolvedDependencies', filter], appMeta), appsMetaInfo);
282
- }
283
- return appsMetaInfo;
284
- };
285
- this.getDependencies = (filter = '') => {
286
- const params = { filter };
287
- const metric = 'apps-get-deps';
288
- const inflightKey = HttpClient_1.inflightUrlWithQuery;
289
- return this.http.get(this.routes.Dependencies(), { params, metric, inflightKey });
290
- };
291
- this.updateDependencies = () => {
292
- return this.http.put(this.routes.Dependencies(), null, { metric: 'apps-update-deps' });
293
- };
294
- this.updateDependency = (name, version, registry) => {
295
- return this.http.patch(this.routes.Apps(), [{ name, version, registry }], { metric: 'apps-update-dep' });
296
- };
297
- this.resolveDependencies = (apps, registries, filter = '') => {
298
- const params = { apps, registries, filter };
299
- const metric = 'apps-resolve-deps';
300
- const inflightKey = HttpClient_1.inflightUrlWithQuery;
301
- return this.http.get(this.routes.ResolveDependencies(), { params, metric, inflightKey });
302
- };
303
- this.resolveDependenciesWithManifest = (manifest, filter = '') => {
304
- const params = { filter };
305
- const metric = 'apps-resolve-deps-m';
306
- return this.http.post(this.routes.ResolveDependenciesWithManifest(), manifest, { params, metric });
307
- };
308
- this.installRuntime = (descriptor) => {
309
- const { account, workspace } = this.context;
310
- const [name, version] = descriptor.split('@');
311
- return this.http.patch(`http://apps.aws-us-east-1.vtex.io/${account}/${workspace}/apps`, [
312
- {
313
- name,
314
- version,
315
- },
316
- ]);
317
- };
318
- this.diskCache = options && options.diskCache;
319
- this.memoryCache = options && options.memoryCache;
320
- this._routes = createRoutes(context);
321
- }
322
- get routes() {
323
- return this._routes;
324
- }
325
- }
326
- exports.Apps = Apps;