@codiac.io/codiac-cli 1.2.169 → 1.2.170

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 (522) hide show
  1. package/README.md +18 -3182
  2. package/bin/dev +16 -16
  3. package/bin/dev.cmd +2 -2
  4. package/bin/run +3 -3
  5. package/bin/run.cmd +3 -3
  6. package/codiac.json +9 -9
  7. package/lib/apis/codiac-api/common/api-client-base.d.ts +165 -165
  8. package/lib/apis/codiac-api/common/api-client-base.js +547 -547
  9. package/lib/apis/codiac-api/common/api-user-creds.d.ts +7 -7
  10. package/lib/apis/codiac-api/common/api-user-creds.js +18 -18
  11. package/lib/apis/codiac-api/common/config-loader.d.ts +6 -6
  12. package/lib/apis/codiac-api/common/config-loader.js +18 -18
  13. package/lib/apis/codiac-api/common/endpoint-spec.d.ts +17 -17
  14. package/lib/apis/codiac-api/common/endpoint-spec.js +27 -27
  15. package/lib/apis/codiac-api/common/security/api-auth-methods-legacy.d.ts +87 -87
  16. package/lib/apis/codiac-api/common/security/api-auth-methods-legacy.js +367 -367
  17. package/lib/apis/codiac-api/common/security/auth-constants.d.ts +15 -15
  18. package/lib/apis/codiac-api/common/security/auth-constants.js +21 -21
  19. package/lib/apis/codiac-api/common/security/i-auth-client.d.ts +44 -44
  20. package/lib/apis/codiac-api/common/security/i-auth-client.js +2 -2
  21. package/lib/apis/codiac-api/common/security/token-holder.d.ts +13 -13
  22. package/lib/apis/codiac-api/common/security/token-holder.js +17 -17
  23. package/lib/apis/codiac-api/common/utils.d.ts +23 -23
  24. package/lib/apis/codiac-api/common/utils.js +82 -82
  25. package/lib/apis/codiac-api/contracts/index.d.ts +1 -1
  26. package/lib/apis/codiac-api/contracts/index.js +4 -4
  27. package/lib/apis/codiac-api/gen/client-config.d.ts +10 -10
  28. package/lib/apis/codiac-api/gen/client-config.js +28 -28
  29. package/lib/apis/codiac-api/gen/client.d.ts +1663 -1663
  30. package/lib/apis/codiac-api/gen/client.js +15629 -15629
  31. package/lib/apis/codiac-api/gen/contracts.d.ts +2722 -2722
  32. package/lib/apis/codiac-api/gen/contracts.js +402 -402
  33. package/lib/apis/codiac-api/index.d.ts +3 -3
  34. package/lib/apis/codiac-api/index.js +8 -8
  35. package/lib/apis/codiac-relay/common/api-client-base.d.ts +165 -165
  36. package/lib/apis/codiac-relay/common/api-client-base.js +547 -547
  37. package/lib/apis/codiac-relay/common/api-user-creds.d.ts +7 -7
  38. package/lib/apis/codiac-relay/common/api-user-creds.js +18 -18
  39. package/lib/apis/codiac-relay/common/config-loader.d.ts +6 -6
  40. package/lib/apis/codiac-relay/common/config-loader.js +18 -18
  41. package/lib/apis/codiac-relay/common/endpoint-spec.d.ts +17 -17
  42. package/lib/apis/codiac-relay/common/endpoint-spec.js +27 -27
  43. package/lib/apis/codiac-relay/common/security/api-auth-methods-legacy.d.ts +87 -87
  44. package/lib/apis/codiac-relay/common/security/api-auth-methods-legacy.js +367 -367
  45. package/lib/apis/codiac-relay/common/security/auth-constants.d.ts +15 -15
  46. package/lib/apis/codiac-relay/common/security/auth-constants.js +21 -21
  47. package/lib/apis/codiac-relay/common/security/i-auth-client.d.ts +44 -44
  48. package/lib/apis/codiac-relay/common/security/i-auth-client.js +2 -2
  49. package/lib/apis/codiac-relay/common/security/token-holder.d.ts +13 -13
  50. package/lib/apis/codiac-relay/common/security/token-holder.js +17 -17
  51. package/lib/apis/codiac-relay/common/utils.d.ts +23 -23
  52. package/lib/apis/codiac-relay/common/utils.js +82 -82
  53. package/lib/apis/codiac-relay/contracts/index.d.ts +1 -1
  54. package/lib/apis/codiac-relay/contracts/index.js +4 -4
  55. package/lib/apis/codiac-relay/gen/client-config.d.ts +10 -10
  56. package/lib/apis/codiac-relay/gen/client-config.js +28 -28
  57. package/lib/apis/codiac-relay/gen/client.d.ts +244 -244
  58. package/lib/apis/codiac-relay/gen/client.js +1862 -1862
  59. package/lib/apis/codiac-relay/gen/contracts.d.ts +3111 -3111
  60. package/lib/apis/codiac-relay/gen/contracts.js +434 -434
  61. package/lib/apis/codiac-relay/index.d.ts +3 -3
  62. package/lib/apis/codiac-relay/index.js +8 -8
  63. package/lib/cli-common/ImagesList.js +66 -66
  64. package/lib/cli-common/argument-manager.d.ts +28 -28
  65. package/lib/cli-common/argument-manager.js +194 -194
  66. package/lib/cli-common/built-in-cli-user-input.d.ts +18 -18
  67. package/lib/cli-common/built-in-cli-user-input.js +309 -309
  68. package/lib/cli-common/cli-interfaces.js +6 -6
  69. package/lib/cli-common/command-base.d.ts +72 -72
  70. package/lib/cli-common/command-base.js +181 -181
  71. package/lib/cli-common/entities/index.d.ts +1 -1
  72. package/lib/cli-common/entities/index.js +4 -4
  73. package/lib/cli-common/entities/prompt-choice.d.ts +7 -7
  74. package/lib/cli-common/entities/prompt-choice.js +2 -2
  75. package/lib/cli-common/file-selector.d.ts +48 -48
  76. package/lib/cli-common/file-selector.js +186 -186
  77. package/lib/cli-common/i-user-input-provider.js +18 -18
  78. package/lib/cli-common/index.d.ts +4 -4
  79. package/lib/cli-common/index.js +10 -10
  80. package/lib/cli-common/mock-ui.d.ts +27 -27
  81. package/lib/cli-common/mock-ui.js +82 -82
  82. package/lib/cli-common/prompt-select-fuzzy.d.ts +19 -19
  83. package/lib/cli-common/prompt-select-fuzzy.js +118 -118
  84. package/lib/cli-common/tenant-contextualizer.js +435 -435
  85. package/lib/cli-common/test/tenant-contextualizer.spec.js +142 -142
  86. package/lib/cli-entities/output-format-enum.d.ts +7 -7
  87. package/lib/cli-entities/output-format-enum.js +11 -11
  88. package/lib/cli-entities/prompt-choice.js +5 -5
  89. package/lib/codiac-constants.d.ts +35 -35
  90. package/lib/codiac-constants.js +40 -40
  91. package/lib/codiac-entities/asset-binding.d.ts +12 -12
  92. package/lib/codiac-entities/asset-binding.js +17 -17
  93. package/lib/codiac-entities/azure-container-registry.d.ts +4 -4
  94. package/lib/codiac-entities/azure-container-registry.js +2 -2
  95. package/lib/codiac-entities/azure-service-principal.d.ts +23 -23
  96. package/lib/codiac-entities/azure-service-principal.js +23 -23
  97. package/lib/codiac-entities/cloud-account-ref.d.ts +28 -28
  98. package/lib/codiac-entities/cloud-account-ref.js +36 -36
  99. package/lib/codiac-entities/deployment-temp.js +132 -132
  100. package/lib/codiac-entities/i-cloud-account-ref.d.ts +5 -5
  101. package/lib/codiac-entities/i-cloud-account-ref.js +2 -2
  102. package/lib/command-base-enterprise.d.ts +121 -121
  103. package/lib/command-base-enterprise.js +523 -523
  104. package/lib/command-base-tenantless.d.ts +44 -44
  105. package/lib/command-base-tenantless.js +172 -172
  106. package/lib/commands/asset/create.d.ts +42 -42
  107. package/lib/commands/asset/create.js +466 -466
  108. package/lib/commands/asset/destroy.d.ts +20 -20
  109. package/lib/commands/asset/destroy.js +128 -128
  110. package/lib/commands/asset/helm.d.ts +23 -23
  111. package/lib/commands/asset/helm.js +152 -152
  112. package/lib/commands/asset/list.d.ts +28 -28
  113. package/lib/commands/asset/list.js +171 -171
  114. package/lib/commands/asset/probe/create.d.ts +38 -38
  115. package/lib/commands/asset/probe/create.js +186 -186
  116. package/lib/commands/asset/recycle.d.ts +23 -23
  117. package/lib/commands/asset/recycle.js +174 -174
  118. package/lib/commands/asset/view.d.ts +188 -188
  119. package/lib/commands/asset/view.js +1364 -1364
  120. package/lib/commands/asset/volume/create.d.ts +23 -23
  121. package/lib/commands/asset/volume/create.js +175 -175
  122. package/lib/commands/asset/volume/delete.d.ts +19 -19
  123. package/lib/commands/asset/volume/delete.js +111 -111
  124. package/lib/commands/asset/volume/list.d.ts +19 -19
  125. package/lib/commands/asset/volume/list.js +69 -69
  126. package/lib/commands/branch/current.d.ts +10 -10
  127. package/lib/commands/branch/current.js +33 -33
  128. package/lib/commands/branch/list.d.ts +15 -15
  129. package/lib/commands/branch/list.js +55 -55
  130. package/lib/commands/branch.d.ts +12 -12
  131. package/lib/commands/branch.js +41 -41
  132. package/lib/commands/build.d.ts +37 -37
  133. package/lib/commands/build.js +118 -118
  134. package/lib/commands/cabinet/create.d.ts +21 -21
  135. package/lib/commands/cabinet/create.js +107 -107
  136. package/lib/commands/cabinet/list.d.ts +23 -23
  137. package/lib/commands/cabinet/list.js +133 -133
  138. package/lib/commands/cabinet/obliterate.d.ts +20 -20
  139. package/lib/commands/cabinet/obliterate.js +82 -82
  140. package/lib/commands/cli.d.ts +10 -10
  141. package/lib/commands/cli.js +99 -99
  142. package/lib/commands/commit.d.ts +11 -11
  143. package/lib/commands/commit.js +39 -39
  144. package/lib/commands/config/add.d.ts +78 -78
  145. package/lib/commands/config/add.js +559 -559
  146. package/lib/commands/config/delete.d.ts +18 -18
  147. package/lib/commands/config/delete.js +118 -118
  148. package/lib/commands/config/deploy.d.ts +22 -22
  149. package/lib/commands/config/deploy.js +124 -124
  150. package/lib/commands/config/import.d.ts +27 -27
  151. package/lib/commands/config/import.js +195 -195
  152. package/lib/commands/config/view.d.ts +25 -25
  153. package/lib/commands/config/view.js +120 -120
  154. package/lib/commands/csp/login.d.ts +18 -18
  155. package/lib/commands/csp/login.js +108 -108
  156. package/lib/commands/csp/logout.d.ts +15 -15
  157. package/lib/commands/csp/logout.js +73 -73
  158. package/lib/commands/dep/create.d.ts +13 -13
  159. package/lib/commands/dep/create.js +40 -40
  160. package/lib/commands/dep/install.d.ts +9 -9
  161. package/lib/commands/dep/install.js +29 -29
  162. package/lib/commands/dep/list.d.ts +55 -55
  163. package/lib/commands/dep/list.js +97 -97
  164. package/lib/commands/dep/remove.d.ts +12 -12
  165. package/lib/commands/dep/remove.js +61 -61
  166. package/lib/commands/dep/source.d.ts +13 -13
  167. package/lib/commands/dep/source.js +82 -82
  168. package/lib/commands/dep/syncup.d.ts +11 -11
  169. package/lib/commands/dep/syncup.js +53 -53
  170. package/lib/commands/dep/unsource.d.ts +14 -14
  171. package/lib/commands/dep/unsource.js +67 -67
  172. package/lib/commands/dep/upgrade.d.ts +44 -44
  173. package/lib/commands/dep/upgrade.js +243 -243
  174. package/lib/commands/dep.d.ts +12 -12
  175. package/lib/commands/dep.js +50 -50
  176. package/lib/commands/deploy.d.ts +38 -38
  177. package/lib/commands/deploy.js +382 -382
  178. package/lib/commands/enterprise/create.d.ts +20 -20
  179. package/lib/commands/enterprise/create.js +97 -97
  180. package/lib/commands/enterprise/list.d.ts +14 -14
  181. package/lib/commands/enterprise/list.js +83 -83
  182. package/lib/commands/env/add.d.ts +22 -22
  183. package/lib/commands/env/add.js +199 -199
  184. package/lib/commands/environment/create.d.ts +19 -19
  185. package/lib/commands/environment/create.js +88 -88
  186. package/lib/commands/environment/list.d.ts +25 -25
  187. package/lib/commands/environment/list.js +157 -157
  188. package/lib/commands/filestore/capture.d.ts +31 -31
  189. package/lib/commands/filestore/capture.js +341 -341
  190. package/lib/commands/host/map.d.ts +33 -33
  191. package/lib/commands/host/map.js +346 -346
  192. package/lib/commands/identity/delete.d.ts +15 -15
  193. package/lib/commands/identity/delete.js +82 -82
  194. package/lib/commands/identity/list.d.ts +11 -11
  195. package/lib/commands/identity/list.js +42 -42
  196. package/lib/commands/identity.d.ts +22 -22
  197. package/lib/commands/identity.js +76 -76
  198. package/lib/commands/imageRegistry/capture.d.ts +27 -27
  199. package/lib/commands/imageRegistry/capture.js +159 -159
  200. package/lib/commands/imageRegistry/forget.d.ts +23 -23
  201. package/lib/commands/imageRegistry/forget.js +160 -160
  202. package/lib/commands/imageRegistry/pullSecret/set.d.ts +27 -27
  203. package/lib/commands/imageRegistry/pullSecret/set.js +299 -299
  204. package/lib/commands/imageRegistry/pullSecret/unset.d.ts +24 -24
  205. package/lib/commands/imageRegistry/pullSecret/unset.js +242 -242
  206. package/lib/commands/images/add.d.ts +25 -25
  207. package/lib/commands/images/add.js +75 -75
  208. package/lib/commands/images/list.d.ts +14 -14
  209. package/lib/commands/images/list.js +71 -71
  210. package/lib/commands/images/patch.d.ts +14 -14
  211. package/lib/commands/images/patch.js +92 -92
  212. package/lib/commands/images/remove.d.ts +12 -12
  213. package/lib/commands/images/remove.js +37 -37
  214. package/lib/commands/images/version.d.ts +16 -16
  215. package/lib/commands/images/version.js +64 -64
  216. package/lib/commands/init.d.ts +17 -17
  217. package/lib/commands/init.js +130 -130
  218. package/lib/commands/kit/create.d.ts +25 -25
  219. package/lib/commands/kit/create.js +141 -141
  220. package/lib/commands/login.d.ts +22 -22
  221. package/lib/commands/login.js +92 -92
  222. package/lib/commands/logout.d.ts +8 -8
  223. package/lib/commands/logout.js +36 -36
  224. package/lib/commands/merge.d.ts +12 -12
  225. package/lib/commands/merge.js +42 -42
  226. package/lib/commands/noc/cluster/create.d.ts +28 -28
  227. package/lib/commands/noc/cluster/create.js +132 -132
  228. package/lib/commands/noc/cluster/deinit.d.ts +17 -17
  229. package/lib/commands/noc/cluster/deinit.js +116 -116
  230. package/lib/commands/noc/cluster/destroy.d.ts +20 -20
  231. package/lib/commands/noc/cluster/destroy.js +137 -137
  232. package/lib/commands/noc/cluster/forget.d.ts +16 -16
  233. package/lib/commands/noc/cluster/forget.js +136 -136
  234. package/lib/commands/noc/cluster/grant.d.ts +24 -24
  235. package/lib/commands/noc/cluster/grant.js +159 -159
  236. package/lib/commands/noc/cluster/init.d.ts +17 -17
  237. package/lib/commands/noc/cluster/init.js +116 -116
  238. package/lib/commands/noc/cluster/list.d.ts +21 -21
  239. package/lib/commands/noc/cluster/list.js +83 -83
  240. package/lib/commands/noc/cluster/recreate.d.ts +28 -28
  241. package/lib/commands/noc/cluster/recreate.js +185 -185
  242. package/lib/commands/pkg/add.d.ts +15 -15
  243. package/lib/commands/pkg/add.js +42 -42
  244. package/lib/commands/pkg/list.d.ts +9 -9
  245. package/lib/commands/pkg/list.js +32 -32
  246. package/lib/commands/pkg/patch.d.ts +13 -13
  247. package/lib/commands/pkg/patch.js +78 -78
  248. package/lib/commands/pkg/remove.d.ts +12 -12
  249. package/lib/commands/pkg/remove.js +69 -69
  250. package/lib/commands/portal.d.ts +11 -11
  251. package/lib/commands/portal.js +81 -81
  252. package/lib/commands/publish.d.ts +21 -21
  253. package/lib/commands/publish.js +51 -51
  254. package/lib/commands/pull.d.ts +13 -13
  255. package/lib/commands/pull.js +29 -29
  256. package/lib/commands/push.d.ts +13 -13
  257. package/lib/commands/push.js +29 -29
  258. package/lib/commands/run.d.ts +35 -35
  259. package/lib/commands/run.js +193 -193
  260. package/lib/commands/secretStore/capture.d.ts +27 -27
  261. package/lib/commands/secretStore/capture.js +174 -174
  262. package/lib/commands/secretStore/forget.d.ts +20 -20
  263. package/lib/commands/secretStore/forget.js +146 -146
  264. package/lib/commands/stage.d.ts +13 -13
  265. package/lib/commands/stage.js +64 -64
  266. package/lib/commands/stash.d.ts +13 -13
  267. package/lib/commands/stash.js +30 -30
  268. package/lib/commands/status.d.ts +12 -12
  269. package/lib/commands/status.js +48 -48
  270. package/lib/commands/stop.d.ts +10 -10
  271. package/lib/commands/stop.js +51 -51
  272. package/lib/commands/switch.d.ts +11 -11
  273. package/lib/commands/switch.js +41 -41
  274. package/lib/commands/sync.d.ts +14 -14
  275. package/lib/commands/sync.js +20 -20
  276. package/lib/commands/tenant/create.d.ts +27 -27
  277. package/lib/commands/tenant/create.js +119 -119
  278. package/lib/commands/tenant/switch.d.ts +24 -24
  279. package/lib/commands/tenant/switch.js +108 -108
  280. package/lib/commands/unstage.d.ts +12 -12
  281. package/lib/commands/unstage.js +57 -57
  282. package/lib/commands/whereami.d.ts +15 -15
  283. package/lib/commands/whereami.js +122 -122
  284. package/lib/commands/whoami.d.ts +8 -8
  285. package/lib/commands/whoami.js +39 -39
  286. package/lib/errors/NoMembershipError.d.ts +8 -8
  287. package/lib/errors/NoMembershipError.js +14 -14
  288. package/lib/index.d.ts +1 -1
  289. package/lib/index.js +16 -16
  290. package/lib/log-update-wrapper.d.ts +24 -24
  291. package/lib/log-update-wrapper.js +28 -28
  292. package/lib/log4js-logger.d.ts +26 -26
  293. package/lib/log4js-logger.js +137 -137
  294. package/lib/ops/INTERFACES_CLI.d.ts +3 -3
  295. package/lib/ops/INTERFACES_CLI.js +7 -7
  296. package/lib/ops/LocalOps.d.ts +444 -444
  297. package/lib/ops/LocalOps.js +3183 -3183
  298. package/lib/ops/azure-container-registry-client/azure-container-registry-client.js +147 -147
  299. package/lib/ops/cli-path-walker.js +54 -54
  300. package/lib/ops/codiac-entities/dependency.d.ts +5 -5
  301. package/lib/ops/codiac-entities/dependency.js +10 -10
  302. package/lib/ops/codiac-entities/index.d.ts +1 -1
  303. package/lib/ops/codiac-entities/index.js +4 -4
  304. package/lib/ops/composite-image-registry-client.js +73 -73
  305. package/lib/ops/data/cli-context-repo.d.ts +61 -61
  306. package/lib/ops/data/cli-context-repo.js +269 -269
  307. package/lib/ops/data/index.d.ts +2 -2
  308. package/lib/ops/data/index.js +5 -5
  309. package/lib/ops/data/npm-config-repo.d.ts +13 -13
  310. package/lib/ops/data/npm-config-repo.js +64 -64
  311. package/lib/ops/docker-config.js +130 -130
  312. package/lib/ops/docker-constants.js +21 -21
  313. package/lib/ops/docker-credentials-store.js +237 -237
  314. package/lib/ops/docker-registry-api-client/docker-registry-api-client.js +288 -288
  315. package/lib/ops/docker-registry-api-client/entities/blob-sum.d.ts +7 -7
  316. package/lib/ops/docker-registry-api-client/entities/blob-sum.js +12 -12
  317. package/lib/ops/docker-registry-api-client/entities/docker-access-actions-enum.d.ts +5 -5
  318. package/lib/ops/docker-registry-api-client/entities/docker-access-actions-enum.js +9 -9
  319. package/lib/ops/docker-registry-api-client/entities/docker-auth-token-criteria.d.ts +30 -30
  320. package/lib/ops/docker-registry-api-client/entities/docker-auth-token-criteria.js +35 -35
  321. package/lib/ops/docker-registry-api-client/entities/i-docker-error-response.d.ts +55 -55
  322. package/lib/ops/docker-registry-api-client/entities/i-docker-error-response.js +51 -51
  323. package/lib/ops/docker-registry-api-client/entities/i-docker-list-response.d.ts +7 -7
  324. package/lib/ops/docker-registry-api-client/entities/i-docker-list-response.js +2 -2
  325. package/lib/ops/docker-registry-api-client/entities/image-repository.d.ts +31 -31
  326. package/lib/ops/docker-registry-api-client/entities/image-repository.js +29 -29
  327. package/lib/ops/docker-registry-api-client/entities/image-tag-criteria.d.ts +8 -8
  328. package/lib/ops/docker-registry-api-client/entities/image-tag-criteria.js +13 -13
  329. package/lib/ops/docker-registry-api-client/entities/image-tag-list.d.ts +7 -7
  330. package/lib/ops/docker-registry-api-client/entities/image-tag-list.js +12 -12
  331. package/lib/ops/docker-registry-api-client/entities/manifest-criteria.d.ts +9 -9
  332. package/lib/ops/docker-registry-api-client/entities/manifest-criteria.js +14 -14
  333. package/lib/ops/docker-registry-api-client/entities/manifest.d.ts +15 -15
  334. package/lib/ops/docker-registry-api-client/entities/manifest.js +20 -20
  335. package/lib/ops/docker-registry-api-client/entities/repository-criteria.d.ts +16 -16
  336. package/lib/ops/docker-registry-api-client/entities/repository-criteria.js +23 -23
  337. package/lib/ops/docker-registry-api-client/entities/token-response.d.ts +15 -15
  338. package/lib/ops/docker-registry-api-client/entities/token-response.js +14 -14
  339. package/lib/ops/docker-registry-api-client/entities/token.d.ts +17 -17
  340. package/lib/ops/docker-registry-api-client/entities/token.js +21 -21
  341. package/lib/ops/docker-registry-api-client/entities/version-check-criteria.d.ts +4 -4
  342. package/lib/ops/docker-registry-api-client/entities/version-check-criteria.js +9 -9
  343. package/lib/ops/dx-constants.d.ts +26 -26
  344. package/lib/ops/dx-constants.js +42 -42
  345. package/lib/ops/entities/ImageBuildContext.d.ts +12 -12
  346. package/lib/ops/entities/ImageBuildContext.js +18 -18
  347. package/lib/ops/entities/PipelineContext.d.ts +21 -21
  348. package/lib/ops/entities/PipelineContext.js +22 -22
  349. package/lib/ops/entities/TenantContext.d.ts +10 -10
  350. package/lib/ops/entities/TenantContext.js +15 -15
  351. package/lib/ops/entities/ThaulConfig.js +29 -29
  352. package/lib/ops/entities/azure-service-principal.d.ts +23 -23
  353. package/lib/ops/entities/azure-service-principal.js +23 -23
  354. package/lib/ops/entities/better-logger.js +1 -1
  355. package/lib/ops/entities/branch.d.ts +13 -13
  356. package/lib/ops/entities/branch.js +15 -15
  357. package/lib/ops/entities/cli-config.d.ts +48 -48
  358. package/lib/ops/entities/cli-config.js +60 -60
  359. package/lib/ops/entities/docker-image.d.ts +60 -60
  360. package/lib/ops/entities/docker-image.js +2 -2
  361. package/lib/ops/entities/helm-spec.d.ts +15 -15
  362. package/lib/ops/entities/helm-spec.js +22 -22
  363. package/lib/ops/entities/index.d.ts +4 -4
  364. package/lib/ops/entities/index.js +11 -11
  365. package/lib/ops/entities/operation-meta.d.ts +8 -8
  366. package/lib/ops/entities/operation-meta.js +18 -18
  367. package/lib/ops/entities/scaffolding.d.ts +19 -19
  368. package/lib/ops/entities/scaffolding.js +20 -20
  369. package/lib/ops/extensions/azart-identity-adapter.d.ts +19 -19
  370. package/lib/ops/extensions/azart-identity-adapter.js +96 -96
  371. package/lib/ops/extensions/npm-identity-adapter-base.d.ts +13 -13
  372. package/lib/ops/extensions/npm-identity-adapter-base.js +2 -2
  373. package/lib/ops/extensions/npmjs-identity-adapter.d.ts +13 -13
  374. package/lib/ops/extensions/npmjs-identity-adapter.js +63 -63
  375. package/lib/ops/git-ops.d.ts +8 -8
  376. package/lib/ops/git-ops.js +13 -13
  377. package/lib/ops/i-client-for-image-registry.js +16 -16
  378. package/lib/ops/i-identity-handler.d.ts +33 -33
  379. package/lib/ops/i-identity-handler.js +164 -164
  380. package/lib/ops/i-output-styler.js +16 -16
  381. package/lib/ops/index.d.ts +12 -12
  382. package/lib/ops/index.js +14 -14
  383. package/lib/ops/json-utils.js +58 -58
  384. package/lib/ops/no-style-output-styler.js +29 -29
  385. package/lib/ops/oauth2-client.ts/oauth2-client.d.ts +23 -23
  386. package/lib/ops/oauth2-client.ts/oauth2-client.js +63 -63
  387. package/lib/ops/project-initializer.d.ts +36 -36
  388. package/lib/ops/project-initializer.js +218 -218
  389. package/lib/ops/scaffolding/base-scaffolding.d.ts +7 -7
  390. package/lib/ops/scaffolding/base-scaffolding.js +20 -20
  391. package/lib/ops/scaffolding/codiac-api-scaffolding.d.ts +7 -7
  392. package/lib/ops/scaffolding/codiac-api-scaffolding.js +63 -63
  393. package/lib/ops/scaffolding/typescript-scaffolding.d.ts +15 -15
  394. package/lib/ops/scaffolding/typescript-scaffolding.js +162 -162
  395. package/lib/ops/test/mock-ui.d.ts +26 -26
  396. package/lib/ops/test/mock-ui.js +87 -87
  397. package/lib/ops/test/test-extensions.d.ts +13 -13
  398. package/lib/ops/test/test-extensions.js +70 -70
  399. package/lib/ops/test/when-a-recursive-file-search-is-run.spec.d.ts +2 -2
  400. package/lib/ops/test/when-a-recursive-file-search-is-run.spec.js +54 -54
  401. package/lib/ops/test/when-git-branchline-is-attempted.spec.d.ts +2 -2
  402. package/lib/ops/test/when-git-branchline-is-attempted.spec.js +37 -37
  403. package/lib/ops/test/when-versions-are-parsed.spec.d.ts +2 -2
  404. package/lib/ops/test/when-versions-are-parsed.spec.js +59 -59
  405. package/lib/ops/throwing-user-input-provider.js +36 -36
  406. package/lib/prettify.d.ts +7 -7
  407. package/lib/prettify.js +23 -23
  408. package/lib/read-stdin.d.ts +2 -2
  409. package/lib/read-stdin.js +28 -28
  410. package/lib/relay/contracts/contracts.d.ts +207 -207
  411. package/lib/relay/contracts/contracts.js +229 -229
  412. package/lib/relay/extended-relay-client.d.ts +27 -27
  413. package/lib/relay/extended-relay-client.js +27 -27
  414. package/lib/relay/relay-container.d.ts +41 -41
  415. package/lib/relay/relay-container.js +297 -297
  416. package/lib/relay/wsclient/relay-socket-listener.d.ts +68 -68
  417. package/lib/relay/wsclient/relay-socket-listener.js +164 -164
  418. package/lib/relay/wsclient/relay-websocket-client.d.ts +33 -33
  419. package/lib/relay/wsclient/relay-websocket-client.js +178 -178
  420. package/lib/relay/wsclient/rx-websocket-subject.d.ts +25 -25
  421. package/lib/relay/wsclient/rx-websocket-subject.js +133 -133
  422. package/lib/relay/wsclient/socket-contracts.d.ts +22 -22
  423. package/lib/relay/wsclient/socket-contracts.js +2 -2
  424. package/lib/standard-probes.d.ts +5 -5
  425. package/lib/standard-probes.js +21 -21
  426. package/lib/uilogic/build-configurator.d.ts +21 -21
  427. package/lib/uilogic/build-configurator.js +110 -110
  428. package/lib/uilogic/cloud-provider-contextualizer.d.ts +46 -46
  429. package/lib/uilogic/cloud-provider-contextualizer.js +193 -193
  430. package/lib/uilogic/cloud-resource-configurator-factory.d.ts +41 -41
  431. package/lib/uilogic/cloud-resource-configurator-factory.js +157 -157
  432. package/lib/uilogic/cloud-resource-configurators/aws-resource-configurator.d.ts +38 -38
  433. package/lib/uilogic/cloud-resource-configurators/aws-resource-configurator.js +347 -347
  434. package/lib/uilogic/cloud-resource-configurators/az-acr-cli-authenticator.js +77 -77
  435. package/lib/uilogic/cloud-resource-configurators/az-interactive-login-configurator.d.ts +42 -42
  436. package/lib/uilogic/cloud-resource-configurators/az-interactive-login-configurator.js +247 -247
  437. package/lib/uilogic/cloud-resource-configurators/azure-resource-configurator.d.ts +110 -110
  438. package/lib/uilogic/cloud-resource-configurators/azure-resource-configurator.js +781 -781
  439. package/lib/uilogic/cloud-resource-configurators/azure-types.js +9 -9
  440. package/lib/uilogic/cloud-resource-configurators/docker-hub-resource-configurator.d.ts +24 -24
  441. package/lib/uilogic/cloud-resource-configurators/docker-hub-resource-configurator.js +105 -105
  442. package/lib/uilogic/cloud-resource-configurators/helm-resource-configurator.d.ts +16 -16
  443. package/lib/uilogic/cloud-resource-configurators/helm-resource-configurator.js +44 -44
  444. package/lib/uilogic/cloud-resource-configurators/unsupported-resource-configurator.d.ts +18 -18
  445. package/lib/uilogic/cloud-resource-configurators/unsupported-resource-configurator.js +61 -61
  446. package/lib/uilogic/enterprise-contextualizer.d.ts +76 -76
  447. package/lib/uilogic/enterprise-contextualizer.js +670 -670
  448. package/lib/uilogic/environment-contextualizer.d.ts +15 -15
  449. package/lib/uilogic/environment-contextualizer.js +42 -42
  450. package/lib/uilogic/i-cluster-configurator.d.ts +9 -9
  451. package/lib/uilogic/i-cluster-configurator.js +2 -2
  452. package/lib/uilogic/i-login-configurator.d.ts +6 -6
  453. package/lib/uilogic/i-login-configurator.js +2 -2
  454. package/lib/uilogic/i-registry-configurator.d.ts +6 -6
  455. package/lib/uilogic/i-registry-configurator.js +2 -2
  456. package/lib/uilogic/i-secret-store-configurator.d.ts +7 -7
  457. package/lib/uilogic/i-secret-store-configurator.js +2 -2
  458. package/lib/uilogic/image-configurator.d.ts +133 -133
  459. package/lib/uilogic/image-configurator.js +577 -577
  460. package/lib/uilogic/image-contextualizer.d.ts +24 -24
  461. package/lib/uilogic/image-contextualizer.js +89 -89
  462. package/lib/uilogic/image-registry-contextualizer.d.ts +28 -28
  463. package/lib/uilogic/image-registry-contextualizer.js +126 -126
  464. package/lib/uilogic/index.d.ts +9 -9
  465. package/lib/uilogic/index.js +13 -13
  466. package/lib/uilogic/prompt-select-fuzzy.js +138 -138
  467. package/lib/uilogic/render-methods.d.ts +12 -12
  468. package/lib/uilogic/render-methods.js +64 -64
  469. package/lib/uilogic/tenant-contextualizer.d.ts +79 -79
  470. package/lib/uilogic/tenant-contextualizer.js +573 -573
  471. package/lib/user-context-loader.d.ts +60 -60
  472. package/lib/user-context-loader.js +183 -183
  473. package/oclif.manifest.json +1 -45
  474. package/package.json +150 -150
  475. package/scaffolding/api/.gitignore-scaffolding +68 -68
  476. package/scaffolding/api/.vscode/launch.json +16 -16
  477. package/scaffolding/api/.vscode/settings.json +7 -7
  478. package/scaffolding/api/.vscode/tasks.json +15 -15
  479. package/scaffolding/api/src/app-config.json +2 -2
  480. package/scaffolding/api/src/index.ts-scaffolding +13 -13
  481. package/scaffolding/api/src/myApiDef.ts-scaffolding +25 -25
  482. package/scaffolding/default/.gitignore-scaffolding +2 -2
  483. package/scaffolding/typescript/.gitignore-scaffolding +69 -69
  484. package/scaffolding/typescript/.vscode/launch.json +16 -16
  485. package/scaffolding/typescript/.vscode/settings.json +7 -7
  486. package/scaffolding/typescript/.vscode/tasks.json +15 -15
  487. package/lib/api-command-base.d.ts +0 -0
  488. package/lib/api-command-base.js +0 -52
  489. package/lib/api-command-base.js.map +0 -1
  490. package/lib/azure-rest-client.d.ts +0 -6
  491. package/lib/azure-rest-client.js +0 -36
  492. package/lib/azure-rest-client.js.map +0 -1
  493. package/lib/commands/view/dashboard.d.ts +0 -17
  494. package/lib/commands/view/dashboard.js +0 -88
  495. package/lib/commands/view/dashboard.js.map +0 -1
  496. package/lib/commands/view/pods.d.ts +0 -14
  497. package/lib/commands/view/pods.js +0 -88
  498. package/lib/commands/view/pods.js.map +0 -1
  499. package/lib/deployment.d.ts +0 -2
  500. package/lib/deployment.js +0 -7
  501. package/lib/deployment.js.map +0 -1
  502. package/lib/k8s-command-base.d.ts +0 -60
  503. package/lib/k8s-command-base.js +0 -204
  504. package/lib/k8s-command-base.js.map +0 -1
  505. package/lib/relay/data/aws-k8s-versions.d.ts +0 -6
  506. package/lib/relay/data/aws-k8s-versions.js +0 -16
  507. package/lib/relay/data/aws-k8s-versions.js.map +0 -1
  508. package/lib/relay/data/aws-node-types.d.ts +0 -37
  509. package/lib/relay/data/aws-node-types.js +0 -4246
  510. package/lib/relay/data/aws-node-types.js.map +0 -1
  511. package/lib/relay/data/aws-regions.d.ts +0 -6
  512. package/lib/relay/data/aws-regions.js +0 -34
  513. package/lib/relay/data/aws-regions.js.map +0 -1
  514. package/lib/uilogic/cloud-resource-configurators/aws-k8s-versions.d.ts +0 -11
  515. package/lib/uilogic/cloud-resource-configurators/aws-k8s-versions.js +0 -16
  516. package/lib/uilogic/cloud-resource-configurators/aws-k8s-versions.js.map +0 -1
  517. package/lib/uilogic/cloud-resource-configurators/aws-node-types.d.ts +0 -5
  518. package/lib/uilogic/cloud-resource-configurators/aws-node-types.js +0 -536
  519. package/lib/uilogic/cloud-resource-configurators/aws-node-types.js.map +0 -1
  520. package/lib/uilogic/cloud-resource-configurators/aws-regions.d.ts +0 -10
  521. package/lib/uilogic/cloud-resource-configurators/aws-regions.js +0 -34
  522. package/lib/uilogic/cloud-resource-configurators/aws-regions.js.map +0 -1
@@ -1,548 +1,548 @@
1
- "use strict";
2
- var ApiClientBase_1;
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.ApiClientBase = exports.TypeName = void 0;
5
- const tslib_1 = require("tslib");
6
- const https = require("https");
7
- const querystring = require("querystring");
8
- const axios_1 = require("axios");
9
- const inversify_1 = require("inversify");
10
- // import _ from "lodash";
11
- const urlPattern = require("url-pattern");
12
- const codiac_common_1 = require("@codiac.io/codiac-common");
13
- const contracts = require("@codiac.io/codiac-common/contracts");
14
- const contracts_1 = require("@codiac.io/codiac-common/contracts");
15
- class TypeName {
16
- static endpointSpec(entityType) {
17
- if (typeof entityType == "string") {
18
- return `endpointSpec<${entityType}>`;
19
- }
20
- else {
21
- return `endpointSpec<${(0, codiac_common_1.typeNameOf)(entityType)}>`;
22
- }
23
- }
24
- // TODO: Promote this to a common/shared library
25
- static arrayOf(entityType) {
26
- if (typeof entityType == "string") {
27
- return `Array<${entityType}>`;
28
- }
29
- else {
30
- return `Array<${(0, codiac_common_1.typeNameOf)(entityType)}>`;
31
- }
32
- }
33
- static criteriaFor(entityType) {
34
- if (typeof entityType == "string") {
35
- return `ICriteria<${entityType}>`;
36
- }
37
- else {
38
- return `ICriteria<${(0, codiac_common_1.typeNameOf)(entityType)}>`;
39
- }
40
- }
41
- }
42
- exports.TypeName = TypeName;
43
- let ApiClientBase = ApiClientBase_1 = class ApiClientBase /* extends AuthClientBase */ {
44
- static bootstrap_base(endpointsJson, logger) {
45
- // MarkStartHere("This may be the only part of this class that makes this client unique. \
46
- // Perhaps this should be loaded form a json file? Can we pass types in that way?");
47
- // // We can do it like this
48
- // this.endpointSpecs.bind<endpointSpec<Asset>>(TypeName.endpointSpec(Asset)).toConstantValue(
49
- // new endpointSpec<Asset>(Asset, httpRestVerb.POST, "/assets/new")
50
- // );
51
- // // or we can do it like this
52
- // let createMany = {
53
- // entityType: Array,
54
- // httpMethod: httpRestVerb.POST,
55
- // route: "/assets"
56
- // };
57
- // // TODO: this isnt binding by httpRestVerb - it needs to be - perhaps use named bindings?
58
- // let typeName = TypeName.endpointSpec(TypeName.arrayOf(Asset));
59
- // this.endpointSpecs.bind<endpointSpec<Array<Asset>>>(typeName).toConstantValue(createMany);
60
- // // can we do it like this? (this would let us keep it all in a generated or even retrieved json file)
61
- // let updateJson = '{ "entityType": "Asset", "httpMethod": "POST", "route": "/assets" }';
62
- // let update = JSON.parse(updateJson);
63
- // this.endpointSpecs.bind(TypeName.endpointSpec(update.entityType)).toConstantValue(update);
64
- this.registerSerializerFor(contracts.StringFilter, new contracts_1.StringFilterExpressionSerializer(true));
65
- // this.registerSerializerFor<contracts.StringListFilter>(contracts.StringListFilter, contracts.StringListFilter.toExpression);
66
- // this.registerSerializerFor<contracts.NumericFilter>(contracts.NumericFilter, contracts.NumericFilter.toExpression);
67
- // this.registerSerializerFor<contracts.NumericListFilter>(contracts.NumericListFilter, contracts.NumericListFilter.toExpression);
68
- for (let index in endpointsJson) {
69
- let spec = endpointsJson[index]; // This is dodging type safety and assumes data integrity in the json file. We should cast
70
- let nameKey = spec.httpMethod.toLowerCase();
71
- if (logger)
72
- logger.trace(`Adding endpoint spec to client endpoint registry: ${spec.entityType}, '${nameKey} ${spec.route}'`);
73
- this.endpointSpecs
74
- .bind(TypeName.endpointSpec(spec.entityType)) // Consider .properBind()
75
- .toConstantValue(spec)
76
- .whenTargetNamed(nameKey);
77
- }
78
- }
79
- /** For special serializers (eg: StringFilter, etc).
80
- * Maps the given serializer for use on the given type
81
- * when later converting input to an http request.
82
- * NOTE: a default serializer will be used if reqd and none has been registered here.
83
- */
84
- static registerSerializerFor(valueType, serializer) {
85
- let typeKey = "";
86
- if (typeof valueType == "string") {
87
- typeKey = valueType;
88
- }
89
- else {
90
- typeKey = (0, codiac_common_1.typeNameOf)(valueType);
91
- }
92
- // All this bc inversify's bind command wont overwrite and results in ambiguous bindings
93
- if (this.serializers.isBoundNamed(codiac_common_1.INTERFACES.ISerializer, typeKey)) {
94
- // I think this DROPS ALL the other named bindings for this service identifier...
95
- this.serializers.rebind(codiac_common_1.INTERFACES.ISerializer)
96
- .toConstantValue(serializer)
97
- .whenTargetNamed(typeKey);
98
- }
99
- else {
100
- this.serializers.bind(codiac_common_1.INTERFACES.ISerializer)
101
- .toConstantValue(serializer)
102
- .whenTargetNamed(typeKey);
103
- }
104
- }
105
- /** Returns undefined when no serializer has been registered for the given valueType. */
106
- static getSerializerFor(valueType) {
107
- let typeKey = "";
108
- if (typeof valueType == "string") {
109
- typeKey = valueType;
110
- }
111
- else {
112
- typeKey = (0, codiac_common_1.typeNameOf)(valueType);
113
- }
114
- let ser;
115
- if (this.serializers.isBoundNamed(codiac_common_1.INTERFACES.ISerializer, typeKey)) {
116
- ser = this.serializers.getNamed(codiac_common_1.INTERFACES.ISerializer, typeKey);
117
- }
118
- return ser;
119
- }
120
- /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
121
- * _____ _ ___ ___ _
122
- * |_ _| | | | \/ | | |
123
- * | | _ __ ___| |_ __ _ _ __ ___ ___ | . . | ___ _ __ ___ | |__ ___ _ __ ___
124
- * | || '_ \/ __| __/ _` | '_ \ / __/ _ \ | |\/| |/ _ \ '_ ` _ \| '_ \ / _ \ '__/ __|
125
- * _| || | | \__ \ || (_| | | | | (_| __/ | | | | __/ | | | | | |_) | __/ | \__ \
126
- * \___/_| |_|___/\__\__,_|_| |_|\___\___| \_| |_/\___|_| |_| |_|_.__/ \___|_| |___/
127
- *
128
- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
129
- /** Local interface for a remote Api.
130
- * @param apiRootUrl Override for this.GetDefaultRootUrl(). Fully qualified base url of the api. That is, prepending it to any individual endpoint route will yield the fully qualified url for that endpoint.
131
- * @param authToken User token for the api this client is targeting.
132
- * NOTE: Also must get hydrated if child class runs successful attempts of authenticate / refreshToken / switchTenant / registerTenant.
133
- */
134
- constructor(logger, apiRootUrl, authToken) {
135
- this.authToken = authToken;
136
- this.apiRootUrl = apiRootUrl || this.GetDefaultRootUrl();
137
- this.tokenHeaderName = ApiClientBase_1.DEFAULT_TOKEN_HEADER_PARAM;
138
- this.logger = logger;
139
- }
140
- /** Sets the user context to impersonate in requests made to the api. */
141
- setUserToken(token) {
142
- this.authToken = token;
143
- }
144
- // =============================
145
- // METHODS CALLING API ENDPOINTS
146
- // =============================
147
- /** Retrieves the registered endpoint spec for the given request type and httpMethod.
148
- * Throws exception if the given entity type and http method are not found.
149
- */
150
- getEndpointFor(entityType, httpMethod) {
151
- let spec;
152
- let reqType = TypeName.endpointSpec(entityType);
153
- let specs = [];
154
- if (ApiClientBase_1.endpointSpecs.isBoundNamed(reqType, httpMethod.toLowerCase())) {
155
- specs = ApiClientBase_1.endpointSpecs.getAllNamed(reqType, httpMethod.toLowerCase());
156
- }
157
- if (specs.length > 0) {
158
- spec = specs[0]; // we're just gonna take the first one.
159
- }
160
- else {
161
- throw new Error(`Client error: No endpoint registered for [${httpMethod} ${reqType}]`);
162
- }
163
- return spec;
164
- }
165
- /** Produces the value for the "Authorization" http header in an RFC 2617 Basic Authentication scheme.
166
- * Consists of the string "Basic " followed by a colon-separated, base64 encoded string of the username and password.
167
- * eg: for userid "Aladdin" and password "open sesame", this function will return "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==".
168
- * @see https://tools.ietf.org/html/rfc2617#page-4 RFC 2617 HTTP Authentication - Assembling the header value for a basic authentication request. */
169
- static buildBasicAuthenticationHeader(userName, passwordOrApiKey) {
170
- let creds = [userName, passwordOrApiKey].join(":");
171
- let credsEncoded = Buffer.from(creds).toString('base64');
172
- let headerValue = `Basic ${credsEncoded}`;
173
- return headerValue;
174
- }
175
- /** Fires off an http request to the remote api.
176
- * Throws any encountered exceptions
177
- * (api exceptions dont get raised: they get passed back in the response envelope).
178
- *
179
- * @param httpVerb
180
- * @param url Can be relative to this.apiBaseUrl or fully qualified.
181
- * @param req
182
- * @param headers
183
- */
184
- makeHttpCall(httpVerb, url, req, headers) {
185
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
186
- return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
187
- try {
188
- this.logger.detail(`Api client making request: ${httpVerb} ${url}`);
189
- let agent = new https.Agent({ rejectUnauthorized: false });
190
- let reqHeaders = {};
191
- reqHeaders["content-type"] = "application/json";
192
- if (this.authToken) {
193
- reqHeaders[this.tokenHeaderName] = this.authToken;
194
- }
195
- if (headers) {
196
- for (let headerKey in headers) {
197
- if (headers[headerKey])
198
- reqHeaders[headerKey] = headers[headerKey];
199
- }
200
- }
201
- let axiosOptions = {
202
- "headers": reqHeaders,
203
- "httpsAgent": agent
204
- };
205
- if (url.indexOf("://") < 0) {
206
- axiosOptions.baseURL = this.apiRootUrl;
207
- }
208
- // TODO: Consider a different http base library for this:
209
- // https://www.npmjs.com/package/got
210
- // https://www.npmjs.com/package/node-fetch
211
- // let apiResponse = await axios.request<TResponse>({ ...axiosOptions, url: url, method: httpVerb, data: req });
212
- return axios_1.default.request(Object.assign(Object.assign({}, axiosOptions), { url: url, method: httpVerb, data: req }))
213
- .then(res => {
214
- this.logger.debug(`Raw response from [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}] [status: ${res.status} ${res.statusText}]`);
215
- resolve(res.data);
216
- })
217
- .catch(err => {
218
- // this.logger.debug(`Error making request [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}]: ${err.message || ""}]`);
219
- // reject(err);
220
- // Might need to do this if axios throws on non-200s...
221
- if (err.response) {
222
- let axr = err.response;
223
- this.logger.debug(`Remote Codiac API returned failure http status: ${axr.status || ""} ${axr.statusText || ""}.`);
224
- // Trying to add axr.data as the attached data to the statement above
225
- // may have been causing the following circular ref err...
226
- //
227
- // TypeError: Converting circular structure to JSON
228
- // --> starting at object with constructor 'TLSSocket'
229
- // | property '_httpMessage' -> object with constructor 'ClientRequest'
230
- // --- property 'socket' closes the circle
231
- // at JSON.stringify (<anonymous>)
232
- // at apiHost.<anonymous> (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:873:49)
233
- // at Generator.next (<anonymous>)
234
- // at fulfilled (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:11:58)
235
- // at processTicksAndRejections (internal/process/task_queues.js:97:5)
236
- resolve(axr.data);
237
- }
238
- else {
239
- this.logger.error(`Error making http call: ${err.message}`, { httpVerb: httpVerb, url: url, error: err });
240
- reject(err);
241
- }
242
- });
243
- }
244
- catch (err) {
245
- reject(err);
246
- }
247
- }));
248
- });
249
- }
250
- /** Fires off an http request to the remote api,
251
- * AND RETURNS THE ENTIRE AXIOS RESPONSE.
252
- * Throws any encountered exceptions
253
- * (api exceptions dont get raised: they get passed back in the response envelope).
254
- *
255
- * @param httpVerb
256
- * @param url Can be relative to this.apiBaseUrl or fully qualified.
257
- * @param req
258
- * @param headers
259
- */
260
- makeRawHttpCall(httpVerb, url, req, headers) {
261
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
262
- return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
263
- try {
264
- this.logger.detail(`Api client making request: ${httpVerb} ${url}`);
265
- let agent = new https.Agent({ rejectUnauthorized: false });
266
- let reqHeaders = {};
267
- reqHeaders["content-type"] = "application/json";
268
- if (this.authToken) {
269
- reqHeaders[this.tokenHeaderName] = this.authToken;
270
- }
271
- if (headers) {
272
- for (let headerKey in headers) {
273
- if (headers[headerKey])
274
- reqHeaders[headerKey] = headers[headerKey];
275
- }
276
- }
277
- let axiosOptions = {
278
- "headers": reqHeaders,
279
- "httpsAgent": agent
280
- };
281
- if (url.indexOf("://") < 0) {
282
- axiosOptions.baseURL = this.apiRootUrl;
283
- }
284
- // TODO: Consider a different http base library for this:
285
- // https://www.npmjs.com/package/got
286
- // https://www.npmjs.com/package/node-fetch
287
- // let apiResponse = await axios.request<TResponse>({ ...axiosOptions, url: url, method: httpVerb, data: req });
288
- return axios_1.default.request(Object.assign(Object.assign({}, axiosOptions), { url: url, method: httpVerb, data: req }))
289
- .then(res => {
290
- this.logger.debug(`Raw response from [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}] [status: ${res.status} ${res.statusText}]`);
291
- resolve(res);
292
- })
293
- .catch(err => {
294
- // this.logger.debug(`Error making request [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}]: ${err.message || ""}]`);
295
- // reject(err);
296
- // Might need to do this if axios throws on non-200s...
297
- if (err.response) {
298
- let axr = err.response;
299
- this.logger.debug(`Remote Codiac API returned failure http status: ${axr.status || ""} ${axr.statusText || ""}.`);
300
- // Trying to add axr.data as the attached data to the statement above
301
- // may have been causing the following circular ref err...
302
- //
303
- // TypeError: Converting circular structure to JSON
304
- // --> starting at object with constructor 'TLSSocket'
305
- // | property '_httpMessage' -> object with constructor 'ClientRequest'
306
- // --- property 'socket' closes the circle
307
- // at JSON.stringify (<anonymous>)
308
- // at apiHost.<anonymous> (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:873:49)
309
- // at Generator.next (<anonymous>)
310
- // at fulfilled (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:11:58)
311
- // at processTicksAndRejections (internal/process/task_queues.js:97:5)
312
- resolve(axr);
313
- }
314
- else {
315
- this.logger.error(`Error making http call: ${err.message}`, { httpVerb: httpVerb, url: url, error: err });
316
- reject(err);
317
- }
318
- });
319
- }
320
- catch (err) {
321
- this.logger.error(`Error forming http request: ${err.message}`, { httpVerb: httpVerb, url: url, error: err });
322
- reject(err);
323
- }
324
- }));
325
- });
326
- }
327
- /** Performs replacements on the route using
328
- * the matching values from the given request object
329
- * @param route The relative url path for the endpoint including route tokens.
330
- * @param applyRemainingToQuerystring (default: false) When set, adds querystring params
331
- * for every property on the entity that was not already applied to a route token.
332
- * */
333
- buildUrl(route, request, applyRemainingToQuerystring = false) {
334
- let pattern = new urlPattern(route, { segmentValueCharset: 'a-zA-Z0-9-_~ %.@' });
335
- let url = pattern.stringify(request);
336
- // Remove the properties of the request that are
337
- // already tokenized in the route
338
- let tokenPattern = /(?!:)\w+/gi; // /(:[^/]\w+)/g
339
- let rx = new RegExp(tokenPattern, "g");
340
- let matches = rx.exec(route);
341
- let remaining = Object.assign({}, request);
342
- let tokens = [];
343
- while (matches) {
344
- // let tokens = matches.map(t => t.slice(1));
345
- tokens.push(...matches);
346
- // TODO: Revisit this to remove token modifiers ()
347
- // This does not remove the modifiers to a token. It assumes tokens are all in format ":property"
348
- remaining = this.omit(remaining, tokens);
349
- matches = rx.exec(route);
350
- }
351
- let qs;
352
- if (applyRemainingToQuerystring) {
353
- // By now we must already have applied any applicable serializers.
354
- // Whatever properties still remain unserialized are meant for the body,
355
- // and cannot occur in the querystring,
356
- // so we dont add anything to the querystring that isnt already a primitive,
357
- // or this method will empty it out, eg: "?myval="
358
- let natives = this.extractPrimitiveProperties(remaining);
359
- qs = querystring.stringify(natives);
360
- }
361
- if (qs) {
362
- url = url.concat("?", qs);
363
- }
364
- return url;
365
- }
366
- /** Returns an object containing only properties with primitive values;
367
- * no objects, or functions.
368
- *
369
- * NOTE: DOES include null values (which javascript still considers objects)
370
- *
371
- * @see [The world picking up the slack on this failure](https://stackoverflow.com/questions/8511281/check-if-a-value-is-an-object-in-javascript/8511350#8511350)
372
- */
373
- extractPrimitiveProperties(remaining) {
374
- if (remaining == undefined)
375
- return undefined;
376
- let prim = {};
377
- for (let prop in remaining) {
378
- if (remaining[prop] === null || (typeof remaining[prop] !== 'object' && typeof remaining[prop] !== 'function')) {
379
- prim[prop] = remaining[prop];
380
- }
381
- }
382
- return prim;
383
- }
384
- /** Serializes property values of the given entity
385
- * whose types have a registered serializer. */
386
- // We dont need the generic signature, and we're not going to have it because we are recursing properties on an entity. AND We're converting properties to strings, so typesafety is now gone.
387
- // serialize<T extends any>(entity: T, serializerMap: stringDictionary): T {
388
- applyPropertySerializers(entity, serializerMap) {
389
- let output = entity;
390
- for (let prop in serializerMap) {
391
- let propType = serializerMap[prop];
392
- if (propType && entity[prop]) {
393
- let ser = ApiClientBase_1.getSerializerFor(propType);
394
- if (ser) {
395
- output[prop] = ser.serialize(entity[prop]);
396
- }
397
- }
398
- }
399
- return output;
400
- }
401
- /** Safe to blindly append this to an existing url tat does not yet have a querystring.
402
- * Returns "?" character if the given obj has properties.
403
- * Returns "" if the given obj is undefined or empty. */
404
- createQueryStringFrom(obj) {
405
- let qs = "";
406
- let sep = "";
407
- for (let prop in obj) {
408
- // TODO Serialize val (if reqd, eg: StringFilter)
409
- let val = querystring.escape(obj[prop]);
410
- qs = qs.concat(`${sep}${prop}=${val}`);
411
- sep = "&";
412
- }
413
- if (qs != "")
414
- qs = "?".concat(qs);
415
- return qs;
416
- }
417
- /** Creates a new object from the given object without the given property paths */
418
- omit(entity, paths) {
419
- let output = Object.assign({}, entity);
420
- for (let path of paths) {
421
- if (output[path]) {
422
- delete output[path];
423
- }
424
- }
425
- return output;
426
- }
427
- /** Very generic method for executing a POST operation against the api
428
- * from an endpoint definition in the registered endpoints collection.
429
- * Hydrates any route parameters or required headers for the endpoint
430
- * from the given requestContract and routeValues objects.
431
- * Throws any exceptions
432
- * (because it cant guarantee a response envelope that declares
433
- * errors and successes, it cant implement a "try" pattern).
434
- * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
435
- */
436
- post(requestType, requestContract, routeValues) {
437
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
438
- return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.POST, requestContract, routeValues);
439
- });
440
- }
441
- /** Very generic method for executing a PUT operation against the api
442
- * from an endpoint definition in the registered endpoints collection.
443
- * Hydrates any route parameters or required headers for the endpoint
444
- * from the given requestContract and routeValues objects.
445
- * Throws any exceptions
446
- * (because it cant guarantee a response envelope that declares
447
- * errors and successes, it cant implement a "try" pattern).
448
- * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
449
- */
450
- put(requestType, requestContract, routeValues) {
451
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
452
- return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.PUT, requestContract, routeValues);
453
- });
454
- }
455
- /** Very generic method for executing a GET operation against the api
456
- * from an endpoint definition in the registered endpoints collection.
457
- * Hydrates any route parameters or required headers for the endpoint
458
- * from the given requestContract and routeValues objects.
459
- * Throws any exceptions
460
- * (because it cant guarantee a response envelope that declares
461
- * errors and successes, it cant implement a "try" pattern).
462
- * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
463
- */
464
- get(requestType, requestContract, routeValues) {
465
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
466
- return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.GET, requestContract, routeValues);
467
- });
468
- }
469
- /** Very generic method for executing a PATCH operation against the api
470
- * from an endpoint definition in the registered endpoints collection.
471
- * Hydrates any route parameters or required headers for the endpoint
472
- * from the given requestContract and routeValues objects.
473
- * Throws any exceptions
474
- * (because it cant guarantee a response envelope that declares
475
- * errors and successes, it cant implement a "try" pattern).
476
- * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
477
- */
478
- patch(requestType, requestContract, routeValues) {
479
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
480
- return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.PATCH, requestContract, routeValues);
481
- });
482
- }
483
- /** Very generic method for executing a DELETE operation against the api
484
- * from an endpoint definition in the registered endpoints collection.
485
- * Hydrates any route parameters or required headers for the endpoint
486
- * from the given requestContract and routeValues objects.
487
- * Throws any exceptions
488
- * (because it cant guarantee a response envelope that declares
489
- * errors and successes, it cant implement a "try" pattern).
490
- * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
491
- */
492
- delete(requestType, requestContract, routeValues) {
493
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
494
- return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.DELETE, requestContract, routeValues);
495
- });
496
- }
497
- /** Very generic method for executing an http operation against the api
498
- * from an endpoint definition in the registered endpoints collection.
499
- * Hydrates any route parameters or required headers for the endpoint
500
- * from the given requestContract and routeValues objects.
501
- * Throws any exceptions
502
- * (because it cant guarantee a response envelope that declares
503
- * errors and successes, it cant implement a "try" pattern).
504
- * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
505
- */
506
- hitConfiguredEndpoint(requestType, httpVerb, requestContract, routeValues) {
507
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
508
- return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
509
- try {
510
- let spec = this.getEndpointFor(requestType, httpVerb);
511
- let headers;
512
- // if (options && options.projection) {
513
- // headers = {};
514
- // headers[Hdr.PROJECTION_INCLUDES] = options.projection.pathsIncluded;
515
- // headers[Hdr.PROJECTION_EXCLUDES] = options.projection.pathsExcluded;
516
- // }
517
- let values = Object.assign(Object.assign({}, requestContract), routeValues);
518
- let stuffIntoQuerystring = (httpVerb == codiac_common_1.httpRestVerb.GET); // Applies the whole request object to the querystring
519
- let url = this.buildUrl(spec.route, values, stuffIntoQuerystring);
520
- this.makeHttpCall(spec.httpMethod, url, requestContract, headers)
521
- .then(result => resolve(result))
522
- .catch(reason => {
523
- this.logger.write(`Exception caught by client from an http ${httpVerb} of type [${(0, codiac_common_1.typeNameOf)(requestType)}]: ${reason.message || reason}`);
524
- reject(reason);
525
- });
526
- }
527
- catch (err) {
528
- this.logger.write(`Client exception attempting to make an http ${httpVerb} of type [${(0, codiac_common_1.typeNameOf)(requestType)}]: ${err.message}`);
529
- reject(err);
530
- }
531
- }));
532
- });
533
- }
534
- };
535
- ApiClientBase.endpointSpecs = new inversify_1.Container();
536
- ApiClientBase.serializers = new inversify_1.Container();
537
- /** Applied to this.tokenHeaderParam in the ctor.
538
- * Typical name of the http request header that declares the authentication token for the request. */
539
- ApiClientBase.DEFAULT_TOKEN_HEADER_PARAM = "authorization";
540
- ApiClientBase = ApiClientBase_1 = tslib_1.__decorate([
541
- (0, inversify_1.injectable)(),
542
- tslib_1.__param(0, (0, inversify_1.inject)(codiac_common_1.INTERFACES.ILogger)),
543
- tslib_1.__param(1, (0, inversify_1.unmanaged)()),
544
- tslib_1.__param(2, (0, inversify_1.unmanaged)()),
545
- tslib_1.__metadata("design:paramtypes", [Object, String, String])
546
- ], ApiClientBase);
547
- exports.ApiClientBase = ApiClientBase;
1
+ "use strict";
2
+ var ApiClientBase_1;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ApiClientBase = exports.TypeName = void 0;
5
+ const tslib_1 = require("tslib");
6
+ const https = require("https");
7
+ const querystring = require("querystring");
8
+ const axios_1 = require("axios");
9
+ const inversify_1 = require("inversify");
10
+ // import _ from "lodash";
11
+ const urlPattern = require("url-pattern");
12
+ const codiac_common_1 = require("@codiac.io/codiac-common");
13
+ const contracts = require("@codiac.io/codiac-common/contracts");
14
+ const contracts_1 = require("@codiac.io/codiac-common/contracts");
15
+ class TypeName {
16
+ static endpointSpec(entityType) {
17
+ if (typeof entityType == "string") {
18
+ return `endpointSpec<${entityType}>`;
19
+ }
20
+ else {
21
+ return `endpointSpec<${(0, codiac_common_1.typeNameOf)(entityType)}>`;
22
+ }
23
+ }
24
+ // TODO: Promote this to a common/shared library
25
+ static arrayOf(entityType) {
26
+ if (typeof entityType == "string") {
27
+ return `Array<${entityType}>`;
28
+ }
29
+ else {
30
+ return `Array<${(0, codiac_common_1.typeNameOf)(entityType)}>`;
31
+ }
32
+ }
33
+ static criteriaFor(entityType) {
34
+ if (typeof entityType == "string") {
35
+ return `ICriteria<${entityType}>`;
36
+ }
37
+ else {
38
+ return `ICriteria<${(0, codiac_common_1.typeNameOf)(entityType)}>`;
39
+ }
40
+ }
41
+ }
42
+ exports.TypeName = TypeName;
43
+ let ApiClientBase = ApiClientBase_1 = class ApiClientBase /* extends AuthClientBase */ {
44
+ static bootstrap_base(endpointsJson, logger) {
45
+ // MarkStartHere("This may be the only part of this class that makes this client unique. \
46
+ // Perhaps this should be loaded form a json file? Can we pass types in that way?");
47
+ // // We can do it like this
48
+ // this.endpointSpecs.bind<endpointSpec<Asset>>(TypeName.endpointSpec(Asset)).toConstantValue(
49
+ // new endpointSpec<Asset>(Asset, httpRestVerb.POST, "/assets/new")
50
+ // );
51
+ // // or we can do it like this
52
+ // let createMany = {
53
+ // entityType: Array,
54
+ // httpMethod: httpRestVerb.POST,
55
+ // route: "/assets"
56
+ // };
57
+ // // TODO: this isnt binding by httpRestVerb - it needs to be - perhaps use named bindings?
58
+ // let typeName = TypeName.endpointSpec(TypeName.arrayOf(Asset));
59
+ // this.endpointSpecs.bind<endpointSpec<Array<Asset>>>(typeName).toConstantValue(createMany);
60
+ // // can we do it like this? (this would let us keep it all in a generated or even retrieved json file)
61
+ // let updateJson = '{ "entityType": "Asset", "httpMethod": "POST", "route": "/assets" }';
62
+ // let update = JSON.parse(updateJson);
63
+ // this.endpointSpecs.bind(TypeName.endpointSpec(update.entityType)).toConstantValue(update);
64
+ this.registerSerializerFor(contracts.StringFilter, new contracts_1.StringFilterExpressionSerializer(true));
65
+ // this.registerSerializerFor<contracts.StringListFilter>(contracts.StringListFilter, contracts.StringListFilter.toExpression);
66
+ // this.registerSerializerFor<contracts.NumericFilter>(contracts.NumericFilter, contracts.NumericFilter.toExpression);
67
+ // this.registerSerializerFor<contracts.NumericListFilter>(contracts.NumericListFilter, contracts.NumericListFilter.toExpression);
68
+ for (let index in endpointsJson) {
69
+ let spec = endpointsJson[index]; // This is dodging type safety and assumes data integrity in the json file. We should cast
70
+ let nameKey = spec.httpMethod.toLowerCase();
71
+ if (logger)
72
+ logger.trace(`Adding endpoint spec to client endpoint registry: ${spec.entityType}, '${nameKey} ${spec.route}'`);
73
+ this.endpointSpecs
74
+ .bind(TypeName.endpointSpec(spec.entityType)) // Consider .properBind()
75
+ .toConstantValue(spec)
76
+ .whenTargetNamed(nameKey);
77
+ }
78
+ }
79
+ /** For special serializers (eg: StringFilter, etc).
80
+ * Maps the given serializer for use on the given type
81
+ * when later converting input to an http request.
82
+ * NOTE: a default serializer will be used if reqd and none has been registered here.
83
+ */
84
+ static registerSerializerFor(valueType, serializer) {
85
+ let typeKey = "";
86
+ if (typeof valueType == "string") {
87
+ typeKey = valueType;
88
+ }
89
+ else {
90
+ typeKey = (0, codiac_common_1.typeNameOf)(valueType);
91
+ }
92
+ // All this bc inversify's bind command wont overwrite and results in ambiguous bindings
93
+ if (this.serializers.isBoundNamed(codiac_common_1.INTERFACES.ISerializer, typeKey)) {
94
+ // I think this DROPS ALL the other named bindings for this service identifier...
95
+ this.serializers.rebind(codiac_common_1.INTERFACES.ISerializer)
96
+ .toConstantValue(serializer)
97
+ .whenTargetNamed(typeKey);
98
+ }
99
+ else {
100
+ this.serializers.bind(codiac_common_1.INTERFACES.ISerializer)
101
+ .toConstantValue(serializer)
102
+ .whenTargetNamed(typeKey);
103
+ }
104
+ }
105
+ /** Returns undefined when no serializer has been registered for the given valueType. */
106
+ static getSerializerFor(valueType) {
107
+ let typeKey = "";
108
+ if (typeof valueType == "string") {
109
+ typeKey = valueType;
110
+ }
111
+ else {
112
+ typeKey = (0, codiac_common_1.typeNameOf)(valueType);
113
+ }
114
+ let ser;
115
+ if (this.serializers.isBoundNamed(codiac_common_1.INTERFACES.ISerializer, typeKey)) {
116
+ ser = this.serializers.getNamed(codiac_common_1.INTERFACES.ISerializer, typeKey);
117
+ }
118
+ return ser;
119
+ }
120
+ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
121
+ * _____ _ ___ ___ _
122
+ * |_ _| | | | \/ | | |
123
+ * | | _ __ ___| |_ __ _ _ __ ___ ___ | . . | ___ _ __ ___ | |__ ___ _ __ ___
124
+ * | || '_ \/ __| __/ _` | '_ \ / __/ _ \ | |\/| |/ _ \ '_ ` _ \| '_ \ / _ \ '__/ __|
125
+ * _| || | | \__ \ || (_| | | | | (_| __/ | | | | __/ | | | | | |_) | __/ | \__ \
126
+ * \___/_| |_|___/\__\__,_|_| |_|\___\___| \_| |_/\___|_| |_| |_|_.__/ \___|_| |___/
127
+ *
128
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
129
+ /** Local interface for a remote Api.
130
+ * @param apiRootUrl Override for this.GetDefaultRootUrl(). Fully qualified base url of the api. That is, prepending it to any individual endpoint route will yield the fully qualified url for that endpoint.
131
+ * @param authToken User token for the api this client is targeting.
132
+ * NOTE: Also must get hydrated if child class runs successful attempts of authenticate / refreshToken / switchTenant / registerTenant.
133
+ */
134
+ constructor(logger, apiRootUrl, authToken) {
135
+ this.authToken = authToken;
136
+ this.apiRootUrl = apiRootUrl || this.GetDefaultRootUrl();
137
+ this.tokenHeaderName = ApiClientBase_1.DEFAULT_TOKEN_HEADER_PARAM;
138
+ this.logger = logger;
139
+ }
140
+ /** Sets the user context to impersonate in requests made to the api. */
141
+ setUserToken(token) {
142
+ this.authToken = token;
143
+ }
144
+ // =============================
145
+ // METHODS CALLING API ENDPOINTS
146
+ // =============================
147
+ /** Retrieves the registered endpoint spec for the given request type and httpMethod.
148
+ * Throws exception if the given entity type and http method are not found.
149
+ */
150
+ getEndpointFor(entityType, httpMethod) {
151
+ let spec;
152
+ let reqType = TypeName.endpointSpec(entityType);
153
+ let specs = [];
154
+ if (ApiClientBase_1.endpointSpecs.isBoundNamed(reqType, httpMethod.toLowerCase())) {
155
+ specs = ApiClientBase_1.endpointSpecs.getAllNamed(reqType, httpMethod.toLowerCase());
156
+ }
157
+ if (specs.length > 0) {
158
+ spec = specs[0]; // we're just gonna take the first one.
159
+ }
160
+ else {
161
+ throw new Error(`Client error: No endpoint registered for [${httpMethod} ${reqType}]`);
162
+ }
163
+ return spec;
164
+ }
165
+ /** Produces the value for the "Authorization" http header in an RFC 2617 Basic Authentication scheme.
166
+ * Consists of the string "Basic " followed by a colon-separated, base64 encoded string of the username and password.
167
+ * eg: for userid "Aladdin" and password "open sesame", this function will return "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==".
168
+ * @see https://tools.ietf.org/html/rfc2617#page-4 RFC 2617 HTTP Authentication - Assembling the header value for a basic authentication request. */
169
+ static buildBasicAuthenticationHeader(userName, passwordOrApiKey) {
170
+ let creds = [userName, passwordOrApiKey].join(":");
171
+ let credsEncoded = Buffer.from(creds).toString('base64');
172
+ let headerValue = `Basic ${credsEncoded}`;
173
+ return headerValue;
174
+ }
175
+ /** Fires off an http request to the remote api.
176
+ * Throws any encountered exceptions
177
+ * (api exceptions dont get raised: they get passed back in the response envelope).
178
+ *
179
+ * @param httpVerb
180
+ * @param url Can be relative to this.apiBaseUrl or fully qualified.
181
+ * @param req
182
+ * @param headers
183
+ */
184
+ makeHttpCall(httpVerb, url, req, headers) {
185
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
186
+ return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
187
+ try {
188
+ this.logger.detail(`Api client making request: ${httpVerb} ${url}`);
189
+ let agent = new https.Agent({ rejectUnauthorized: false });
190
+ let reqHeaders = {};
191
+ reqHeaders["content-type"] = "application/json";
192
+ if (this.authToken) {
193
+ reqHeaders[this.tokenHeaderName] = this.authToken;
194
+ }
195
+ if (headers) {
196
+ for (let headerKey in headers) {
197
+ if (headers[headerKey])
198
+ reqHeaders[headerKey] = headers[headerKey];
199
+ }
200
+ }
201
+ let axiosOptions = {
202
+ "headers": reqHeaders,
203
+ "httpsAgent": agent
204
+ };
205
+ if (url.indexOf("://") < 0) {
206
+ axiosOptions.baseURL = this.apiRootUrl;
207
+ }
208
+ // TODO: Consider a different http base library for this:
209
+ // https://www.npmjs.com/package/got
210
+ // https://www.npmjs.com/package/node-fetch
211
+ // let apiResponse = await axios.request<TResponse>({ ...axiosOptions, url: url, method: httpVerb, data: req });
212
+ return axios_1.default.request(Object.assign(Object.assign({}, axiosOptions), { url: url, method: httpVerb, data: req }))
213
+ .then(res => {
214
+ this.logger.debug(`Raw response from [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}] [status: ${res.status} ${res.statusText}]`);
215
+ resolve(res.data);
216
+ })
217
+ .catch(err => {
218
+ // this.logger.debug(`Error making request [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}]: ${err.message || ""}]`);
219
+ // reject(err);
220
+ // Might need to do this if axios throws on non-200s...
221
+ if (err.response) {
222
+ let axr = err.response;
223
+ this.logger.debug(`Remote Codiac API returned failure http status: ${axr.status || ""} ${axr.statusText || ""}.`);
224
+ // Trying to add axr.data as the attached data to the statement above
225
+ // may have been causing the following circular ref err...
226
+ //
227
+ // TypeError: Converting circular structure to JSON
228
+ // --> starting at object with constructor 'TLSSocket'
229
+ // | property '_httpMessage' -> object with constructor 'ClientRequest'
230
+ // --- property 'socket' closes the circle
231
+ // at JSON.stringify (<anonymous>)
232
+ // at apiHost.<anonymous> (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:873:49)
233
+ // at Generator.next (<anonymous>)
234
+ // at fulfilled (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:11:58)
235
+ // at processTicksAndRejections (internal/process/task_queues.js:97:5)
236
+ resolve(axr.data);
237
+ }
238
+ else {
239
+ this.logger.error(`Error making http call: ${err.message}`, { httpVerb: httpVerb, url: url, error: err });
240
+ reject(err);
241
+ }
242
+ });
243
+ }
244
+ catch (err) {
245
+ reject(err);
246
+ }
247
+ }));
248
+ });
249
+ }
250
+ /** Fires off an http request to the remote api,
251
+ * AND RETURNS THE ENTIRE AXIOS RESPONSE.
252
+ * Throws any encountered exceptions
253
+ * (api exceptions dont get raised: they get passed back in the response envelope).
254
+ *
255
+ * @param httpVerb
256
+ * @param url Can be relative to this.apiBaseUrl or fully qualified.
257
+ * @param req
258
+ * @param headers
259
+ */
260
+ makeRawHttpCall(httpVerb, url, req, headers) {
261
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
262
+ return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
263
+ try {
264
+ this.logger.detail(`Api client making request: ${httpVerb} ${url}`);
265
+ let agent = new https.Agent({ rejectUnauthorized: false });
266
+ let reqHeaders = {};
267
+ reqHeaders["content-type"] = "application/json";
268
+ if (this.authToken) {
269
+ reqHeaders[this.tokenHeaderName] = this.authToken;
270
+ }
271
+ if (headers) {
272
+ for (let headerKey in headers) {
273
+ if (headers[headerKey])
274
+ reqHeaders[headerKey] = headers[headerKey];
275
+ }
276
+ }
277
+ let axiosOptions = {
278
+ "headers": reqHeaders,
279
+ "httpsAgent": agent
280
+ };
281
+ if (url.indexOf("://") < 0) {
282
+ axiosOptions.baseURL = this.apiRootUrl;
283
+ }
284
+ // TODO: Consider a different http base library for this:
285
+ // https://www.npmjs.com/package/got
286
+ // https://www.npmjs.com/package/node-fetch
287
+ // let apiResponse = await axios.request<TResponse>({ ...axiosOptions, url: url, method: httpVerb, data: req });
288
+ return axios_1.default.request(Object.assign(Object.assign({}, axiosOptions), { url: url, method: httpVerb, data: req }))
289
+ .then(res => {
290
+ this.logger.debug(`Raw response from [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}] [status: ${res.status} ${res.statusText}]`);
291
+ resolve(res);
292
+ })
293
+ .catch(err => {
294
+ // this.logger.debug(`Error making request [${httpVerb} ${url}] against apiRootUrl: [${this.apiRootUrl}]: ${err.message || ""}]`);
295
+ // reject(err);
296
+ // Might need to do this if axios throws on non-200s...
297
+ if (err.response) {
298
+ let axr = err.response;
299
+ this.logger.debug(`Remote Codiac API returned failure http status: ${axr.status || ""} ${axr.statusText || ""}.`);
300
+ // Trying to add axr.data as the attached data to the statement above
301
+ // may have been causing the following circular ref err...
302
+ //
303
+ // TypeError: Converting circular structure to JSON
304
+ // --> starting at object with constructor 'TLSSocket'
305
+ // | property '_httpMessage' -> object with constructor 'ClientRequest'
306
+ // --- property 'socket' closes the circle
307
+ // at JSON.stringify (<anonymous>)
308
+ // at apiHost.<anonymous> (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:873:49)
309
+ // at Generator.next (<anonymous>)
310
+ // at fulfilled (/app/node_modules/@codiac.io/codiac-api-base/apiCore/apiHost.js:11:58)
311
+ // at processTicksAndRejections (internal/process/task_queues.js:97:5)
312
+ resolve(axr);
313
+ }
314
+ else {
315
+ this.logger.error(`Error making http call: ${err.message}`, { httpVerb: httpVerb, url: url, error: err });
316
+ reject(err);
317
+ }
318
+ });
319
+ }
320
+ catch (err) {
321
+ this.logger.error(`Error forming http request: ${err.message}`, { httpVerb: httpVerb, url: url, error: err });
322
+ reject(err);
323
+ }
324
+ }));
325
+ });
326
+ }
327
+ /** Performs replacements on the route using
328
+ * the matching values from the given request object
329
+ * @param route The relative url path for the endpoint including route tokens.
330
+ * @param applyRemainingToQuerystring (default: false) When set, adds querystring params
331
+ * for every property on the entity that was not already applied to a route token.
332
+ * */
333
+ buildUrl(route, request, applyRemainingToQuerystring = false) {
334
+ let pattern = new urlPattern(route, { segmentValueCharset: 'a-zA-Z0-9-_~ %.@' });
335
+ let url = pattern.stringify(request);
336
+ // Remove the properties of the request that are
337
+ // already tokenized in the route
338
+ let tokenPattern = /(?!:)\w+/gi; // /(:[^/]\w+)/g
339
+ let rx = new RegExp(tokenPattern, "g");
340
+ let matches = rx.exec(route);
341
+ let remaining = Object.assign({}, request);
342
+ let tokens = [];
343
+ while (matches) {
344
+ // let tokens = matches.map(t => t.slice(1));
345
+ tokens.push(...matches);
346
+ // TODO: Revisit this to remove token modifiers ()
347
+ // This does not remove the modifiers to a token. It assumes tokens are all in format ":property"
348
+ remaining = this.omit(remaining, tokens);
349
+ matches = rx.exec(route);
350
+ }
351
+ let qs;
352
+ if (applyRemainingToQuerystring) {
353
+ // By now we must already have applied any applicable serializers.
354
+ // Whatever properties still remain unserialized are meant for the body,
355
+ // and cannot occur in the querystring,
356
+ // so we dont add anything to the querystring that isnt already a primitive,
357
+ // or this method will empty it out, eg: "?myval="
358
+ let natives = this.extractPrimitiveProperties(remaining);
359
+ qs = querystring.stringify(natives);
360
+ }
361
+ if (qs) {
362
+ url = url.concat("?", qs);
363
+ }
364
+ return url;
365
+ }
366
+ /** Returns an object containing only properties with primitive values;
367
+ * no objects, or functions.
368
+ *
369
+ * NOTE: DOES include null values (which javascript still considers objects)
370
+ *
371
+ * @see [The world picking up the slack on this failure](https://stackoverflow.com/questions/8511281/check-if-a-value-is-an-object-in-javascript/8511350#8511350)
372
+ */
373
+ extractPrimitiveProperties(remaining) {
374
+ if (remaining == undefined)
375
+ return undefined;
376
+ let prim = {};
377
+ for (let prop in remaining) {
378
+ if (remaining[prop] === null || (typeof remaining[prop] !== 'object' && typeof remaining[prop] !== 'function')) {
379
+ prim[prop] = remaining[prop];
380
+ }
381
+ }
382
+ return prim;
383
+ }
384
+ /** Serializes property values of the given entity
385
+ * whose types have a registered serializer. */
386
+ // We dont need the generic signature, and we're not going to have it because we are recursing properties on an entity. AND We're converting properties to strings, so typesafety is now gone.
387
+ // serialize<T extends any>(entity: T, serializerMap: stringDictionary): T {
388
+ applyPropertySerializers(entity, serializerMap) {
389
+ let output = entity;
390
+ for (let prop in serializerMap) {
391
+ let propType = serializerMap[prop];
392
+ if (propType && entity[prop]) {
393
+ let ser = ApiClientBase_1.getSerializerFor(propType);
394
+ if (ser) {
395
+ output[prop] = ser.serialize(entity[prop]);
396
+ }
397
+ }
398
+ }
399
+ return output;
400
+ }
401
+ /** Safe to blindly append this to an existing url tat does not yet have a querystring.
402
+ * Returns "?" character if the given obj has properties.
403
+ * Returns "" if the given obj is undefined or empty. */
404
+ createQueryStringFrom(obj) {
405
+ let qs = "";
406
+ let sep = "";
407
+ for (let prop in obj) {
408
+ // TODO Serialize val (if reqd, eg: StringFilter)
409
+ let val = querystring.escape(obj[prop]);
410
+ qs = qs.concat(`${sep}${prop}=${val}`);
411
+ sep = "&";
412
+ }
413
+ if (qs != "")
414
+ qs = "?".concat(qs);
415
+ return qs;
416
+ }
417
+ /** Creates a new object from the given object without the given property paths */
418
+ omit(entity, paths) {
419
+ let output = Object.assign({}, entity);
420
+ for (let path of paths) {
421
+ if (output[path]) {
422
+ delete output[path];
423
+ }
424
+ }
425
+ return output;
426
+ }
427
+ /** Very generic method for executing a POST operation against the api
428
+ * from an endpoint definition in the registered endpoints collection.
429
+ * Hydrates any route parameters or required headers for the endpoint
430
+ * from the given requestContract and routeValues objects.
431
+ * Throws any exceptions
432
+ * (because it cant guarantee a response envelope that declares
433
+ * errors and successes, it cant implement a "try" pattern).
434
+ * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
435
+ */
436
+ post(requestType, requestContract, routeValues) {
437
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
438
+ return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.POST, requestContract, routeValues);
439
+ });
440
+ }
441
+ /** Very generic method for executing a PUT operation against the api
442
+ * from an endpoint definition in the registered endpoints collection.
443
+ * Hydrates any route parameters or required headers for the endpoint
444
+ * from the given requestContract and routeValues objects.
445
+ * Throws any exceptions
446
+ * (because it cant guarantee a response envelope that declares
447
+ * errors and successes, it cant implement a "try" pattern).
448
+ * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
449
+ */
450
+ put(requestType, requestContract, routeValues) {
451
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
452
+ return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.PUT, requestContract, routeValues);
453
+ });
454
+ }
455
+ /** Very generic method for executing a GET operation against the api
456
+ * from an endpoint definition in the registered endpoints collection.
457
+ * Hydrates any route parameters or required headers for the endpoint
458
+ * from the given requestContract and routeValues objects.
459
+ * Throws any exceptions
460
+ * (because it cant guarantee a response envelope that declares
461
+ * errors and successes, it cant implement a "try" pattern).
462
+ * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
463
+ */
464
+ get(requestType, requestContract, routeValues) {
465
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
466
+ return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.GET, requestContract, routeValues);
467
+ });
468
+ }
469
+ /** Very generic method for executing a PATCH operation against the api
470
+ * from an endpoint definition in the registered endpoints collection.
471
+ * Hydrates any route parameters or required headers for the endpoint
472
+ * from the given requestContract and routeValues objects.
473
+ * Throws any exceptions
474
+ * (because it cant guarantee a response envelope that declares
475
+ * errors and successes, it cant implement a "try" pattern).
476
+ * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
477
+ */
478
+ patch(requestType, requestContract, routeValues) {
479
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
480
+ return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.PATCH, requestContract, routeValues);
481
+ });
482
+ }
483
+ /** Very generic method for executing a DELETE operation against the api
484
+ * from an endpoint definition in the registered endpoints collection.
485
+ * Hydrates any route parameters or required headers for the endpoint
486
+ * from the given requestContract and routeValues objects.
487
+ * Throws any exceptions
488
+ * (because it cant guarantee a response envelope that declares
489
+ * errors and successes, it cant implement a "try" pattern).
490
+ * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
491
+ */
492
+ delete(requestType, requestContract, routeValues) {
493
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
494
+ return this.hitConfiguredEndpoint(requestType, codiac_common_1.httpRestVerb.DELETE, requestContract, routeValues);
495
+ });
496
+ }
497
+ /** Very generic method for executing an http operation against the api
498
+ * from an endpoint definition in the registered endpoints collection.
499
+ * Hydrates any route parameters or required headers for the endpoint
500
+ * from the given requestContract and routeValues objects.
501
+ * Throws any exceptions
502
+ * (because it cant guarantee a response envelope that declares
503
+ * errors and successes, it cant implement a "try" pattern).
504
+ * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
505
+ */
506
+ hitConfiguredEndpoint(requestType, httpVerb, requestContract, routeValues) {
507
+ return tslib_1.__awaiter(this, void 0, void 0, function* () {
508
+ return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
509
+ try {
510
+ let spec = this.getEndpointFor(requestType, httpVerb);
511
+ let headers;
512
+ // if (options && options.projection) {
513
+ // headers = {};
514
+ // headers[Hdr.PROJECTION_INCLUDES] = options.projection.pathsIncluded;
515
+ // headers[Hdr.PROJECTION_EXCLUDES] = options.projection.pathsExcluded;
516
+ // }
517
+ let values = Object.assign(Object.assign({}, requestContract), routeValues);
518
+ let stuffIntoQuerystring = (httpVerb == codiac_common_1.httpRestVerb.GET); // Applies the whole request object to the querystring
519
+ let url = this.buildUrl(spec.route, values, stuffIntoQuerystring);
520
+ this.makeHttpCall(spec.httpMethod, url, requestContract, headers)
521
+ .then(result => resolve(result))
522
+ .catch(reason => {
523
+ this.logger.write(`Exception caught by client from an http ${httpVerb} of type [${(0, codiac_common_1.typeNameOf)(requestType)}]: ${reason.message || reason}`);
524
+ reject(reason);
525
+ });
526
+ }
527
+ catch (err) {
528
+ this.logger.write(`Client exception attempting to make an http ${httpVerb} of type [${(0, codiac_common_1.typeNameOf)(requestType)}]: ${err.message}`);
529
+ reject(err);
530
+ }
531
+ }));
532
+ });
533
+ }
534
+ };
535
+ ApiClientBase.endpointSpecs = new inversify_1.Container();
536
+ ApiClientBase.serializers = new inversify_1.Container();
537
+ /** Applied to this.tokenHeaderParam in the ctor.
538
+ * Typical name of the http request header that declares the authentication token for the request. */
539
+ ApiClientBase.DEFAULT_TOKEN_HEADER_PARAM = "authorization";
540
+ ApiClientBase = ApiClientBase_1 = tslib_1.__decorate([
541
+ (0, inversify_1.injectable)(),
542
+ tslib_1.__param(0, (0, inversify_1.inject)(codiac_common_1.INTERFACES.ILogger)),
543
+ tslib_1.__param(1, (0, inversify_1.unmanaged)()),
544
+ tslib_1.__param(2, (0, inversify_1.unmanaged)()),
545
+ tslib_1.__metadata("design:paramtypes", [Object, String, String])
546
+ ], ApiClientBase);
547
+ exports.ApiClientBase = ApiClientBase;
548
548
  //# sourceMappingURL=api-client-base.js.map