ibm-cloud-sdk-core 2.17.0 → 2.17.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (304) hide show
  1. package/.cra/.cveignore +0 -4
  2. package/.secrets.baseline +12 -2
  3. package/CHANGELOG.md +28 -0
  4. package/api-extractor.json +39 -0
  5. package/auth/authenticators/basic-authenticator.js +5 -2
  6. package/auth/authenticators/bearer-token-authenticator.js +5 -2
  7. package/auth/authenticators/token-request-based-authenticator.js +5 -2
  8. package/auth/token-managers/container-token-manager.js +4 -1
  9. package/auth/token-managers/cp4d-token-manager.js +5 -2
  10. package/auth/token-managers/iam-request-based-token-manager.js +6 -3
  11. package/auth/token-managers/jwt-token-manager.js +6 -3
  12. package/auth/token-managers/token-manager.js +4 -1
  13. package/auth/token-managers/vpc-instance-token-manager.js +10 -4
  14. package/auth/utils/file-reading-helpers.js +17 -14
  15. package/auth/utils/read-external-sources.js +9 -6
  16. package/build/docs/ibm-cloud-sdk-core.atleastone.md +27 -0
  17. package/build/docs/ibm-cloud-sdk-core.atmostone.md +27 -0
  18. package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md +18 -0
  19. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md +28 -0
  20. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md +19 -0
  21. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_basic.md +13 -0
  22. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md +11 -0
  23. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_container.md +11 -0
  24. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_cp4d.md +11 -0
  25. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam.md +11 -0
  26. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_noauth.md +11 -0
  27. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_unknown.md +11 -0
  28. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_vpc.md +11 -0
  29. package/build/docs/ibm-cloud-sdk-core.authenticator.md +41 -0
  30. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md +24 -0
  31. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md +17 -0
  32. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.md +21 -0
  33. package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md +20 -0
  34. package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md +11 -0
  35. package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md +24 -0
  36. package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md +26 -0
  37. package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_name.md +11 -0
  38. package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_url.md +11 -0
  39. package/build/docs/ibm-cloud-sdk-core.baseservice.disableretries.md +17 -0
  40. package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md +24 -0
  41. package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md +19 -0
  42. package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.md +17 -0
  43. package/build/docs/ibm-cloud-sdk-core.baseservice.md +43 -0
  44. package/build/docs/ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md +24 -0
  45. package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md +24 -0
  46. package/build/docs/ibm-cloud-sdk-core.basicauthenticator._constructor_.md +24 -0
  47. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md +26 -0
  48. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md +19 -0
  49. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authheader.md +13 -0
  50. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.md +39 -0
  51. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md +11 -0
  52. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md +24 -0
  53. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md +26 -0
  54. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md +19 -0
  55. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.md +39 -0
  56. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md +11 -0
  57. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md +24 -0
  58. package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.md +26 -0
  59. package/build/docs/ibm-cloud-sdk-core.checkcredentials.md +27 -0
  60. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md +24 -0
  61. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md +19 -0
  62. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.md +38 -0
  63. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md +11 -0
  64. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md +11 -0
  65. package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.md +27 -0
  66. package/build/docs/ibm-cloud-sdk-core.constructfilepath.md +22 -0
  67. package/build/docs/ibm-cloud-sdk-core.constructserviceurl.md +28 -0
  68. package/build/docs/ibm-cloud-sdk-core.containerauthenticator._constructor_.md +24 -0
  69. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md +19 -0
  70. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.md +40 -0
  71. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md +24 -0
  72. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md +24 -0
  73. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md +24 -0
  74. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md +11 -0
  75. package/build/docs/ibm-cloud-sdk-core.containertokenmanager._constructor_.md +20 -0
  76. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.md +30 -0
  77. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.requesttoken.md +19 -0
  78. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md +24 -0
  79. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md +24 -0
  80. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md +24 -0
  81. package/build/docs/ibm-cloud-sdk-core.contenttype.md +14 -0
  82. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md +20 -0
  83. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.md +35 -0
  84. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md +15 -0
  85. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md +11 -0
  86. package/build/docs/ibm-cloud-sdk-core.fileexistsatpath.md +22 -0
  87. package/build/docs/ibm-cloud-sdk-core.fileobject.md +27 -0
  88. package/build/docs/ibm-cloud-sdk-core.fileobject.options.md +11 -0
  89. package/build/docs/ibm-cloud-sdk-core.fileobject.value.md +11 -0
  90. package/build/docs/ibm-cloud-sdk-core.fileoptions.contenttype.md +11 -0
  91. package/build/docs/ibm-cloud-sdk-core.fileoptions.filename.md +11 -0
  92. package/build/docs/ibm-cloud-sdk-core.fileoptions.md +19 -0
  93. package/build/docs/ibm-cloud-sdk-core.filestream.md +19 -0
  94. package/build/docs/ibm-cloud-sdk-core.filestream.path.md +11 -0
  95. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.contenttype.md +11 -0
  96. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.data.md +11 -0
  97. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.filename.md +11 -0
  98. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.md +20 -0
  99. package/build/docs/ibm-cloud-sdk-core.getauthenticatorfromenvironment.md +26 -0
  100. package/build/docs/ibm-cloud-sdk-core.getcontenttype.md +26 -0
  101. package/build/docs/ibm-cloud-sdk-core.getcurrenttime.md +19 -0
  102. package/build/docs/ibm-cloud-sdk-core.getformat.md +29 -0
  103. package/build/docs/ibm-cloud-sdk-core.getmissingparams.md +29 -0
  104. package/build/docs/ibm-cloud-sdk-core.getqueryparam.md +31 -0
  105. package/build/docs/ibm-cloud-sdk-core.iamauthenticator._constructor_.md +24 -0
  106. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md +19 -0
  107. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.md +38 -0
  108. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md +11 -0
  109. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md +11 -0
  110. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md +24 -0
  111. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md +11 -0
  112. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md +11 -0
  113. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md +19 -0
  114. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md +38 -0
  115. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md +11 -0
  116. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md +25 -0
  117. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md +24 -0
  118. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md +11 -0
  119. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md +20 -0
  120. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md +11 -0
  121. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md +19 -0
  122. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md +38 -0
  123. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md +11 -0
  124. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md +19 -0
  125. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md +26 -0
  126. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md +27 -0
  127. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md +26 -0
  128. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientid.md +11 -0
  129. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md +11 -0
  130. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.md +23 -0
  131. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.md +11 -0
  132. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._constructor_.md +20 -0
  133. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.md +27 -0
  134. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md +11 -0
  135. package/build/docs/ibm-cloud-sdk-core.isemptyobject.md +22 -0
  136. package/build/docs/ibm-cloud-sdk-core.isfiledata.md +22 -0
  137. package/build/docs/ibm-cloud-sdk-core.isfilewithmetadata.md +22 -0
  138. package/build/docs/ibm-cloud-sdk-core.ishtml.md +26 -0
  139. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md +20 -0
  140. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.md +35 -0
  141. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md +19 -0
  142. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md +26 -0
  143. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md +11 -0
  144. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokenname.md +11 -0
  145. package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.md +15 -0
  146. package/build/docs/ibm-cloud-sdk-core.md +94 -0
  147. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticate.md +22 -0
  148. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md +19 -0
  149. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.md +22 -0
  150. package/build/docs/ibm-cloud-sdk-core.onlyone.md +27 -0
  151. package/build/docs/ibm-cloud-sdk-core.qs.md +21 -0
  152. package/build/docs/ibm-cloud-sdk-core.readcredentialsfile.md +17 -0
  153. package/build/docs/ibm-cloud-sdk-core.readcrtokenfile.md +22 -0
  154. package/build/docs/ibm-cloud-sdk-core.readexternalsources.md +26 -0
  155. package/build/docs/ibm-cloud-sdk-core.removesuffix.md +27 -0
  156. package/build/docs/ibm-cloud-sdk-core.streamtopromise.md +24 -0
  157. package/build/docs/ibm-cloud-sdk-core.striptrailingslash.md +24 -0
  158. package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md +20 -0
  159. package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.md +11 -0
  160. package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.md +11 -0
  161. package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.md +11 -0
  162. package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md +17 -0
  163. package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.md +11 -0
  164. package/build/docs/ibm-cloud-sdk-core.tokenmanager.md +43 -0
  165. package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md +19 -0
  166. package/build/docs/ibm-cloud-sdk-core.tokenmanager.refreshtime.md +11 -0
  167. package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md +19 -0
  168. package/build/docs/ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md +11 -0
  169. package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md +26 -0
  170. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md +26 -0
  171. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md +26 -0
  172. package/build/docs/ibm-cloud-sdk-core.tokenmanager.url.md +11 -0
  173. package/build/docs/ibm-cloud-sdk-core.tokenmanageroptions.md +18 -0
  174. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md +20 -0
  175. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md +26 -0
  176. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md +11 -0
  177. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md +11 -0
  178. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md +42 -0
  179. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md +24 -0
  180. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md +24 -0
  181. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md +11 -0
  182. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md +11 -0
  183. package/build/docs/ibm-cloud-sdk-core.tolowerkeys.md +26 -0
  184. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md +26 -0
  185. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md +28 -0
  186. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md +28 -0
  187. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkuserheader.md +28 -0
  188. package/build/docs/ibm-cloud-sdk-core.unittestutils.expecttobepromise.md +26 -0
  189. package/build/docs/ibm-cloud-sdk-core.unittestutils.getoptions.md +26 -0
  190. package/build/docs/ibm-cloud-sdk-core.unittestutils.md +17 -0
  191. package/build/docs/ibm-cloud-sdk-core.useroptions.authenticator.md +13 -0
  192. package/build/docs/ibm-cloud-sdk-core.useroptions.disablesslverification.md +13 -0
  193. package/build/docs/ibm-cloud-sdk-core.useroptions.headers.md +13 -0
  194. package/build/docs/ibm-cloud-sdk-core.useroptions.jar.md +13 -0
  195. package/build/docs/ibm-cloud-sdk-core.useroptions.md +26 -0
  196. package/build/docs/ibm-cloud-sdk-core.useroptions.serviceurl.md +13 -0
  197. package/build/docs/ibm-cloud-sdk-core.useroptions.url.md +13 -0
  198. package/build/docs/ibm-cloud-sdk-core.useroptions.version.md +13 -0
  199. package/build/docs/ibm-cloud-sdk-core.validateinput.md +23 -0
  200. package/build/docs/ibm-cloud-sdk-core.validateparams.md +30 -0
  201. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md +20 -0
  202. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md +19 -0
  203. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.md +39 -0
  204. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md +24 -0
  205. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md +24 -0
  206. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md +11 -0
  207. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md +20 -0
  208. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md +29 -0
  209. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md +15 -0
  210. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md +24 -0
  211. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md +24 -0
  212. package/build/docs/index.md +12 -0
  213. package/docs/ibm-cloud-sdk-core.api.json +7237 -0
  214. package/es/auth/authenticators/authenticator-interface.d.ts +46 -0
  215. package/es/auth/authenticators/authenticator-interface.js +15 -0
  216. package/es/auth/authenticators/authenticator.d.ts +62 -0
  217. package/es/auth/authenticators/authenticator.js +56 -0
  218. package/es/auth/authenticators/basic-authenticator.d.ts +65 -0
  219. package/es/auth/authenticators/basic-authenticator.js +70 -0
  220. package/es/auth/authenticators/bearer-token-authenticator.d.ts +68 -0
  221. package/es/auth/authenticators/bearer-token-authenticator.js +78 -0
  222. package/es/auth/authenticators/cloud-pak-for-data-authenticator.d.ts +65 -0
  223. package/es/auth/authenticators/cloud-pak-for-data-authenticator.js +63 -0
  224. package/es/auth/authenticators/container-authenticator.d.ts +84 -0
  225. package/es/auth/authenticators/container-authenticator.js +96 -0
  226. package/es/auth/authenticators/iam-authenticator.d.ts +64 -0
  227. package/es/auth/authenticators/iam-authenticator.js +69 -0
  228. package/es/auth/authenticators/iam-request-based-authenticator.d.ts +84 -0
  229. package/es/auth/authenticators/iam-request-based-authenticator.js +82 -0
  230. package/es/auth/authenticators/index.d.ts +52 -0
  231. package/es/auth/authenticators/index.js +25 -0
  232. package/es/auth/authenticators/no-auth-authenticator.d.ts +31 -0
  233. package/es/auth/authenticators/no-auth-authenticator.js +36 -0
  234. package/es/auth/authenticators/token-request-based-authenticator.d.ts +91 -0
  235. package/es/auth/authenticators/token-request-based-authenticator.js +95 -0
  236. package/es/auth/authenticators/vpc-instance-authenticator.d.ts +68 -0
  237. package/es/auth/authenticators/vpc-instance-authenticator.js +84 -0
  238. package/es/auth/index.d.ts +18 -0
  239. package/es/auth/index.js +18 -0
  240. package/es/auth/token-managers/container-token-manager.d.ts +75 -0
  241. package/es/auth/token-managers/container-token-manager.js +121 -0
  242. package/es/auth/token-managers/cp4d-token-manager.d.ts +69 -0
  243. package/es/auth/token-managers/cp4d-token-manager.js +78 -0
  244. package/es/auth/token-managers/iam-request-based-token-manager.d.ts +97 -0
  245. package/es/auth/token-managers/iam-request-based-token-manager.js +152 -0
  246. package/es/auth/token-managers/iam-token-manager.d.ts +49 -0
  247. package/es/auth/token-managers/iam-token-manager.js +52 -0
  248. package/es/auth/token-managers/index.d.ts +41 -0
  249. package/es/auth/token-managers/index.js +41 -0
  250. package/es/auth/token-managers/jwt-token-manager.d.ts +39 -0
  251. package/es/auth/token-managers/jwt-token-manager.js +93 -0
  252. package/es/auth/token-managers/token-manager.d.ts +127 -0
  253. package/es/auth/token-managers/token-manager.js +175 -0
  254. package/es/auth/token-managers/vpc-instance-token-manager.d.ts +57 -0
  255. package/es/auth/token-managers/vpc-instance-token-manager.js +144 -0
  256. package/es/auth/utils/file-reading-helpers.browser.d.ts +17 -0
  257. package/es/auth/utils/file-reading-helpers.browser.js +22 -0
  258. package/es/auth/utils/file-reading-helpers.d.ts +23 -0
  259. package/es/auth/utils/file-reading-helpers.js +98 -0
  260. package/es/auth/utils/get-authenticator-from-environment.d.ts +28 -0
  261. package/es/auth/utils/get-authenticator-from-environment.js +91 -0
  262. package/es/auth/utils/helpers.d.ts +81 -0
  263. package/es/auth/utils/helpers.js +129 -0
  264. package/es/auth/utils/index.d.ts +27 -0
  265. package/es/auth/utils/index.js +27 -0
  266. package/es/auth/utils/read-external-sources.d.ts +10 -0
  267. package/es/auth/utils/read-external-sources.js +143 -0
  268. package/es/index.d.ts +26 -0
  269. package/es/index.js +26 -0
  270. package/es/lib/base-service.d.ts +140 -0
  271. package/es/lib/base-service.js +202 -0
  272. package/es/lib/content-type.d.ts +7 -0
  273. package/es/lib/content-type.js +71 -0
  274. package/es/lib/helper.d.ts +126 -0
  275. package/es/lib/helper.js +288 -0
  276. package/es/lib/logger.d.ts +24 -0
  277. package/es/lib/logger.js +45 -0
  278. package/es/lib/querystring.d.ts +19 -0
  279. package/es/lib/querystring.js +27 -0
  280. package/es/lib/request-wrapper.d.ts +60 -0
  281. package/es/lib/request-wrapper.js +479 -0
  282. package/es/lib/sdk-test-helpers.browser.d.ts +21 -0
  283. package/es/lib/sdk-test-helpers.browser.js +23 -0
  284. package/es/lib/sdk-test-helpers.d.ts +77 -0
  285. package/es/lib/sdk-test-helpers.js +95 -0
  286. package/es/lib/stream-to-promise.d.ts +26 -0
  287. package/es/lib/stream-to-promise.js +37 -0
  288. package/es/tsdoc-metadata.json +11 -0
  289. package/etc/ibm-cloud-sdk-core.api.md +463 -0
  290. package/ibm-cloud-sdk-core.d.ts +1560 -0
  291. package/index.js +8 -1
  292. package/lib/base-service.js +4 -1
  293. package/lib/helper.d.ts +16 -0
  294. package/lib/helper.js +59 -4
  295. package/lib/logger.d.ts +6 -5
  296. package/lib/logger.js +9 -6
  297. package/lib/request-wrapper.js +38 -28
  298. package/lib/sdk-test-helpers.js +11 -8
  299. package/lib/stream-to-promise.d.ts +2 -1
  300. package/lib/stream-to-promise.js +3 -2
  301. package/package.json +17 -6
  302. package/temp/ibm-cloud-sdk-core.api.json +7237 -0
  303. package/temp/ibm-cloud-sdk-core.api.md +463 -0
  304. package/tsconfig-es6.json +9 -0
package/.cra/.cveignore CHANGED
@@ -1,6 +1,2 @@
1
1
  [
2
- {
3
- "cve": "CVE-2021-3807",
4
- "alwaysOmit": true
5
- }
6
2
  ]
package/.secrets.baseline CHANGED
@@ -3,7 +3,7 @@
3
3
  "files": "package-lock.json|^.secrets.baseline$",
4
4
  "lines": null
5
5
  },
6
- "generated_at": "2021-10-27T20:42:11Z",
6
+ "generated_at": "2021-12-05T15:56:18Z",
7
7
  "plugins_used": [
8
8
  {
9
9
  "name": "AWSKeyDetector"
@@ -291,6 +291,16 @@
291
291
  "verified_result": null
292
292
  }
293
293
  ],
294
+ "etc/ibm-cloud-sdk-core.api.md": [
295
+ {
296
+ "hashed_secret": "45c43fe97e3a06ab078b0eeff6fbe622cc417a25",
297
+ "is_secret": false,
298
+ "is_verified": false,
299
+ "line_number": 272,
300
+ "type": "Secret Keyword",
301
+ "verified_result": null
302
+ }
303
+ ],
294
304
  "scripts/jsdoc/generate_index_html.sh": [
295
305
  {
296
306
  "hashed_secret": "973f71aa51bf4dcef6aa10f52089747a85c64a73",
@@ -524,7 +534,7 @@
524
534
  }
525
535
  ]
526
536
  },
527
- "version": "0.13.1+ibm.40.dss",
537
+ "version": "0.13.1+ibm.46.dss",
528
538
  "word_list": {
529
539
  "file": null,
530
540
  "hash": null
package/CHANGELOG.md CHANGED
@@ -1,3 +1,31 @@
1
+ ## [2.17.4](https://github.com/IBM/node-sdk-core/compare/v2.17.3...v2.17.4) (2021-12-16)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * don't always convert bytes to text in streamToPromise ([#182](https://github.com/IBM/node-sdk-core/issues/182)) ([7fe261b](https://github.com/IBM/node-sdk-core/commit/7fe261b20f934cd3fde45acc69b9d4888836aa69))
7
+
8
+ ## [2.17.3](https://github.com/IBM/node-sdk-core/compare/v2.17.2...v2.17.3) (2021-12-13)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * bump dependencies to avoid vulnerability alerts ([#183](https://github.com/IBM/node-sdk-core/issues/183)) ([aef2c6a](https://github.com/IBM/node-sdk-core/commit/aef2c6a2b2a58ce71990b4ae754a3a0ce32e64fd))
14
+
15
+ ## [2.17.2](https://github.com/IBM/node-sdk-core/compare/v2.17.1...v2.17.2) (2021-12-08)
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * **VpcInstanceAuthenticator:** omit request body for default profile scenario ([#181](https://github.com/IBM/node-sdk-core/issues/181)) ([1e3fb2d](https://github.com/IBM/node-sdk-core/commit/1e3fb2d8efede7f1382538d4a4918b16e04deeea))
21
+
22
+ ## [2.17.1](https://github.com/IBM/node-sdk-core/compare/v2.17.0...v2.17.1) (2021-12-06)
23
+
24
+
25
+ ### Bug Fixes
26
+
27
+ * add new validateParams function ([#180](https://github.com/IBM/node-sdk-core/issues/180)) ([514d187](https://github.com/IBM/node-sdk-core/commit/514d187895cb1aa9ca5c642a9dcfccf8e09eb0ed))
28
+
1
29
  # [2.17.0](https://github.com/IBM/node-sdk-core/compare/v2.16.0...v2.17.0) (2021-11-08)
2
30
 
3
31
 
@@ -0,0 +1,39 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "mainEntryPointFilePath": "<projectFolder>/dist/es/index.d.ts",
4
+ "bundledPackages": [],
5
+ "apiReport": {
6
+ "enabled": true
7
+ },
8
+ "docModel": {
9
+ "enabled": true
10
+ },
11
+ "dtsRollup": {
12
+ "enabled": true
13
+ },
14
+ "tsdocMetadata": {
15
+ "enabled": true
16
+ },
17
+ "messages": {
18
+ "compilerMessageReporting": {
19
+ "default": {
20
+ "logLevel": "warning"
21
+ }
22
+ },
23
+
24
+ "extractorMessageReporting": {
25
+ "default": {
26
+ "logLevel": "warning"
27
+ },
28
+ "ae-missing-release-tag": {
29
+ "logLevel": "none"
30
+ }
31
+ },
32
+
33
+ "tsdocMessageReporting": {
34
+ "default": {
35
+ "logLevel": "warning"
36
+ }
37
+ }
38
+ }
39
+ }
@@ -27,8 +27,11 @@ var __extends = (this && this.__extends) || (function () {
27
27
  d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
28
  };
29
29
  })();
30
+ var __importDefault = (this && this.__importDefault) || function (mod) {
31
+ return (mod && mod.__esModule) ? mod : { "default": mod };
32
+ };
30
33
  Object.defineProperty(exports, "__esModule", { value: true });
31
- var extend = require("extend");
34
+ var extend_1 = __importDefault(require("extend"));
32
35
  var utils_1 = require("../utils");
33
36
  var authenticator_1 = require("./authenticator");
34
37
  /**
@@ -72,7 +75,7 @@ var BasicAuthenticator = /** @class */ (function (_super) {
72
75
  BasicAuthenticator.prototype.authenticate = function (requestOptions) {
73
76
  var _this = this;
74
77
  return new Promise(function (resolve) {
75
- requestOptions.headers = extend(true, {}, requestOptions.headers, _this.authHeader);
78
+ requestOptions.headers = extend_1.default(true, {}, requestOptions.headers, _this.authHeader);
76
79
  resolve();
77
80
  });
78
81
  };
@@ -27,8 +27,11 @@ var __extends = (this && this.__extends) || (function () {
27
27
  d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
28
  };
29
29
  })();
30
+ var __importDefault = (this && this.__importDefault) || function (mod) {
31
+ return (mod && mod.__esModule) ? mod : { "default": mod };
32
+ };
30
33
  Object.defineProperty(exports, "__esModule", { value: true });
31
- var extend = require("extend");
34
+ var extend_1 = __importDefault(require("extend"));
32
35
  var utils_1 = require("../utils");
33
36
  var authenticator_1 = require("./authenticator");
34
37
  /**
@@ -80,7 +83,7 @@ var BearerTokenAuthenticator = /** @class */ (function (_super) {
80
83
  var _this = this;
81
84
  return new Promise(function (resolve) {
82
85
  var authHeader = { Authorization: "Bearer " + _this.bearerToken };
83
- requestOptions.headers = extend(true, {}, requestOptions.headers, authHeader);
86
+ requestOptions.headers = extend_1.default(true, {}, requestOptions.headers, authHeader);
84
87
  resolve();
85
88
  });
86
89
  };
@@ -27,8 +27,11 @@ var __extends = (this && this.__extends) || (function () {
27
27
  d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
28
  };
29
29
  })();
30
+ var __importDefault = (this && this.__importDefault) || function (mod) {
31
+ return (mod && mod.__esModule) ? mod : { "default": mod };
32
+ };
30
33
  Object.defineProperty(exports, "__esModule", { value: true });
31
- var extend = require("extend");
34
+ var extend_1 = __importDefault(require("extend"));
32
35
  var token_managers_1 = require("../token-managers");
33
36
  var authenticator_1 = require("./authenticator");
34
37
  /**
@@ -106,7 +109,7 @@ var TokenRequestBasedAuthenticator = /** @class */ (function (_super) {
106
109
  TokenRequestBasedAuthenticator.prototype.authenticate = function (requestOptions) {
107
110
  return this.tokenManager.getToken().then(function (token) {
108
111
  var authHeader = { Authorization: "Bearer " + token };
109
- requestOptions.headers = extend(true, {}, requestOptions.headers, authHeader);
112
+ requestOptions.headers = extend_1.default(true, {}, requestOptions.headers, authHeader);
110
113
  });
111
114
  };
112
115
  return TokenRequestBasedAuthenticator;
@@ -63,8 +63,11 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
63
63
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
64
64
  }
65
65
  };
66
+ var __importDefault = (this && this.__importDefault) || function (mod) {
67
+ return (mod && mod.__esModule) ? mod : { "default": mod };
68
+ };
66
69
  Object.defineProperty(exports, "__esModule", { value: true });
67
- var logger_1 = require("../../lib/logger");
70
+ var logger_1 = __importDefault(require("../../lib/logger"));
68
71
  var utils_1 = require("../utils");
69
72
  var iam_request_based_token_manager_1 = require("./iam-request-based-token-manager");
70
73
  var DEFAULT_CR_TOKEN_FILEPATH = '/var/run/secrets/tokens/vault-token';
@@ -27,8 +27,11 @@ var __extends = (this && this.__extends) || (function () {
27
27
  d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
28
  };
29
29
  })();
30
+ var __importDefault = (this && this.__importDefault) || function (mod) {
31
+ return (mod && mod.__esModule) ? mod : { "default": mod };
32
+ };
30
33
  Object.defineProperty(exports, "__esModule", { value: true });
31
- var extend = require("extend");
34
+ var extend_1 = __importDefault(require("extend"));
32
35
  var utils_1 = require("../utils");
33
36
  var jwt_token_manager_1 = require("./jwt-token-manager");
34
37
  /**
@@ -86,7 +89,7 @@ var Cp4dTokenManager = /** @class */ (function (_super) {
86
89
  api_key: this.apikey,
87
90
  },
88
91
  method: 'POST',
89
- headers: extend(true, {}, this.headers, requiredHeaders),
92
+ headers: extend_1.default(true, {}, this.headers, requiredHeaders),
90
93
  rejectUnauthorized: !this.disableSslVerification,
91
94
  },
92
95
  };
@@ -27,9 +27,12 @@ var __extends = (this && this.__extends) || (function () {
27
27
  d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
28
  };
29
29
  })();
30
+ var __importDefault = (this && this.__importDefault) || function (mod) {
31
+ return (mod && mod.__esModule) ? mod : { "default": mod };
32
+ };
30
33
  Object.defineProperty(exports, "__esModule", { value: true });
31
- var extend = require("extend");
32
- var logger_1 = require("../../lib/logger");
34
+ var extend_1 = __importDefault(require("extend"));
35
+ var logger_1 = __importDefault(require("../../lib/logger"));
33
36
  var utils_1 = require("../utils");
34
37
  var jwt_token_manager_1 = require("./jwt-token-manager");
35
38
  var CLIENT_ID_SECRET_WARNING = 'Warning: Client ID and Secret must BOTH be given, or the header will not be included.';
@@ -160,7 +163,7 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
160
163
  options: {
161
164
  url: this.url + OPERATION_PATH,
162
165
  method: 'POST',
163
- headers: extend(true, {}, this.headers, requiredHeaders),
166
+ headers: extend_1.default(true, {}, this.headers, requiredHeaders),
164
167
  form: this.formData,
165
168
  rejectUnauthorized: !this.disableSslVerification,
166
169
  },
@@ -24,6 +24,9 @@ var __assign = (this && this.__assign) || function () {
24
24
  };
25
25
  return __assign.apply(this, arguments);
26
26
  };
27
+ var __importDefault = (this && this.__importDefault) || function (mod) {
28
+ return (mod && mod.__esModule) ? mod : { "default": mod };
29
+ };
27
30
  Object.defineProperty(exports, "__esModule", { value: true });
28
31
  /**
29
32
  * (C) Copyright IBM Corp. 2019, 2021.
@@ -40,8 +43,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
40
43
  * See the License for the specific language governing permissions and
41
44
  * limitations under the License.
42
45
  */
43
- var jwt = require("jsonwebtoken");
44
- var logger_1 = require("../../lib/logger");
46
+ var jsonwebtoken_1 = require("jsonwebtoken");
47
+ var logger_1 = __importDefault(require("../../lib/logger"));
45
48
  var token_manager_1 = require("./token-manager");
46
49
  /**
47
50
  * A class for shared functionality for parsing, storing, and requesting
@@ -99,7 +102,7 @@ var JwtTokenManager = /** @class */ (function (_super) {
99
102
  }
100
103
  // the time of expiration is found by decoding the JWT access token
101
104
  // exp is the time of expire and iat is the time of token retrieval
102
- var decodedResponse = jwt.decode(this.accessToken);
105
+ var decodedResponse = jsonwebtoken_1.decode(this.accessToken);
103
106
  if (!decodedResponse) {
104
107
  var err = 'Access token recieved is not a valid JWT';
105
108
  logger_1.default.error(err);
@@ -1,8 +1,11 @@
1
1
  "use strict";
2
2
  /* eslint-disable @typescript-eslint/no-unused-vars, class-methods-use-this */
3
+ var __importDefault = (this && this.__importDefault) || function (mod) {
4
+ return (mod && mod.__esModule) ? mod : { "default": mod };
5
+ };
3
6
  Object.defineProperty(exports, "__esModule", { value: true });
4
7
  var helper_1 = require("../../lib/helper");
5
- var logger_1 = require("../../lib/logger");
8
+ var logger_1 = __importDefault(require("../../lib/logger"));
6
9
  var request_wrapper_1 = require("../../lib/request-wrapper");
7
10
  var utils_1 = require("../utils");
8
11
  /**
@@ -63,8 +63,11 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
63
63
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
64
64
  }
65
65
  };
66
+ var __importDefault = (this && this.__importDefault) || function (mod) {
67
+ return (mod && mod.__esModule) ? mod : { "default": mod };
68
+ };
66
69
  Object.defineProperty(exports, "__esModule", { value: true });
67
- var logger_1 = require("../../lib/logger");
70
+ var logger_1 = __importDefault(require("../../lib/logger"));
68
71
  var utils_1 = require("../utils");
69
72
  var jwt_token_manager_1 = require("./jwt-token-manager");
70
73
  var DEFAULT_IMS_ENDPOINT = 'http://169.254.169.254';
@@ -126,12 +129,15 @@ var VpcInstanceTokenManager = /** @class */ (function (_super) {
126
129
  case 0: return [4 /*yield*/, this.getInstanceIdentityToken()];
127
130
  case 1:
128
131
  instanceIdentityToken = _a.sent();
129
- body = {};
130
132
  if (this.iamProfileId) {
131
- body.trusted_profile = { id: this.iamProfileId };
133
+ body = {
134
+ trusted_profile: { id: this.iamProfileId },
135
+ };
132
136
  }
133
137
  else if (this.iamProfileCrn) {
134
- body.trusted_profile = { crn: this.iamProfileCrn };
138
+ body = {
139
+ trusted_profile: { crn: this.iamProfileCrn },
140
+ };
135
141
  }
136
142
  parameters = {
137
143
  options: {
@@ -14,12 +14,15 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
+ var __importDefault = (this && this.__importDefault) || function (mod) {
18
+ return (mod && mod.__esModule) ? mod : { "default": mod };
19
+ };
17
20
  Object.defineProperty(exports, "__esModule", { value: true });
18
- var dotenv = require("dotenv");
19
- var fs = require("fs");
20
- var os = require("os");
21
- var path = require("path");
22
- var logger_1 = require("../../lib/logger");
21
+ var dotenv_1 = require("dotenv");
22
+ var fs_1 = require("fs");
23
+ var os_1 = require("os");
24
+ var path_1 = require("path");
25
+ var logger_1 = __importDefault(require("../../lib/logger"));
23
26
  // Putting all file-reading related code in this file to isolate the usage of the
24
27
  // `fs` module, as it causes problems in browser environments.
25
28
  var defaultCredsFilename = 'ibm-credentials.env';
@@ -28,7 +31,7 @@ var defaultCredsFilename = 'ibm-credentials.env';
28
31
  * be specified filepath via the environment variable: `IBM_CREDENTIALS_FILE`.
29
32
  */
30
33
  function readCredentialsFile() {
31
- if (!fs.existsSync) {
34
+ if (!fs_1.existsSync) {
32
35
  return {};
33
36
  }
34
37
  // first look for an env variable called IBM_CREDENTIALS_FILE
@@ -37,7 +40,7 @@ function readCredentialsFile() {
37
40
  // then at the os-dependent home directory
38
41
  var givenFilepath = process.env.IBM_CREDENTIALS_FILE || '';
39
42
  var workingDir = constructFilepath(process.cwd());
40
- var homeDir = constructFilepath(os.homedir());
43
+ var homeDir = constructFilepath(os_1.homedir());
41
44
  var filepathToUse;
42
45
  if (givenFilepath) {
43
46
  if (fileExistsAtPath(givenFilepath)) {
@@ -60,13 +63,13 @@ function readCredentialsFile() {
60
63
  logger_1.default.info('Credential file does not exist. Will not be used');
61
64
  return {};
62
65
  }
63
- var credsFile = fs.readFileSync(filepathToUse);
64
- return dotenv.parse(credsFile);
66
+ var credsFile = fs_1.readFileSync(filepathToUse);
67
+ return dotenv_1.parse(credsFile);
65
68
  }
66
69
  exports.readCredentialsFile = readCredentialsFile;
67
70
  function fileExistsAtPath(filepath) {
68
- if (fs.existsSync(filepath)) {
69
- var stats = fs.lstatSync(filepath);
71
+ if (fs_1.existsSync(filepath)) {
72
+ var stats = fs_1.lstatSync(filepath);
70
73
  return stats.isFile() || stats.isSymbolicLink();
71
74
  }
72
75
  return false;
@@ -75,19 +78,19 @@ exports.fileExistsAtPath = fileExistsAtPath;
75
78
  function constructFilepath(filepath) {
76
79
  // ensure filepath includes the filename
77
80
  if (!filepath.endsWith(defaultCredsFilename)) {
78
- filepath = path.join(filepath, defaultCredsFilename);
81
+ filepath = path_1.join(filepath, defaultCredsFilename);
79
82
  }
80
83
  return filepath;
81
84
  }
82
85
  exports.constructFilepath = constructFilepath;
83
86
  function readCrTokenFile(filepath) {
84
- if (!fs.existsSync) {
87
+ if (!fs_1.existsSync) {
85
88
  return '';
86
89
  }
87
90
  var token = '';
88
91
  var fileExists = fileExistsAtPath(filepath);
89
92
  if (fileExists) {
90
- token = fs.readFileSync(filepath, 'utf8');
93
+ token = fs_1.readFileSync(filepath, 'utf8');
91
94
  logger_1.default.debug("Successfully read CR token from file: " + filepath);
92
95
  }
93
96
  if (token === '') {
@@ -1,5 +1,8 @@
1
1
  "use strict";
2
2
  /* eslint-disable no-restricted-syntax */
3
+ var __importDefault = (this && this.__importDefault) || function (mod) {
4
+ return (mod && mod.__esModule) ? mod : { "default": mod };
5
+ };
3
6
  Object.defineProperty(exports, "__esModule", { value: true });
4
7
  /**
5
8
  * (C) Copyright IBM Corp. 2019, 2021.
@@ -16,9 +19,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
19
  * See the License for the specific language governing permissions and
17
20
  * limitations under the License.
18
21
  */
19
- var camelcase = require("camelcase");
20
- var isEmpty = require("lodash.isempty");
21
- var logger_1 = require("../../lib/logger");
22
+ var camelcase_1 = __importDefault(require("camelcase"));
23
+ var lodash_isempty_1 = __importDefault(require("lodash.isempty"));
24
+ var logger_1 = __importDefault(require("../../lib/logger"));
22
25
  var file_reading_helpers_1 = require("./file-reading-helpers");
23
26
  /**
24
27
  * Read properties stored in external sources like Environment Variables,
@@ -44,10 +47,10 @@ function getProperties(serviceName) {
44
47
  // only get properties from one source, return null if none found
45
48
  var properties = null;
46
49
  properties = filterPropertiesByServiceName(file_reading_helpers_1.readCredentialsFile(), serviceName);
47
- if (isEmpty(properties)) {
50
+ if (lodash_isempty_1.default(properties)) {
48
51
  properties = filterPropertiesByServiceName(process.env, serviceName);
49
52
  }
50
- if (isEmpty(properties)) {
53
+ if (lodash_isempty_1.default(properties)) {
51
54
  properties = getPropertiesFromVCAP(serviceName);
52
55
  }
53
56
  return properties;
@@ -69,7 +72,7 @@ function filterPropertiesByServiceName(envObj, serviceName) {
69
72
  // filter out properties that don't begin with the service name
70
73
  Object.keys(envObj).forEach(function (key) {
71
74
  if (key.startsWith(name)) {
72
- var propName = camelcase(key.substring(name.length)); // remove the name from the front of the string and make camelcase
75
+ var propName = camelcase_1.default(key.substring(name.length)); // remove the name from the front of the string and make camelcase
73
76
  credentials[propName] = envObj[key];
74
77
  }
75
78
  });
@@ -0,0 +1,27 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [atLeastOne](./ibm-cloud-sdk-core.atleastone.md)
4
+
5
+ ## atLeastOne() function
6
+
7
+ Check for at least one of two elements being defined. Returns true if a or b is defined. Returns false if both are undefined.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export declare function atLeastOne(a: any, b: any): boolean;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | a | any | The first object |
20
+ | b | any | The second object |
21
+
22
+ <b>Returns:</b>
23
+
24
+ boolean
25
+
26
+ {<!-- -->boolean<!-- -->}
27
+
@@ -0,0 +1,27 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [atMostOne](./ibm-cloud-sdk-core.atmostone.md)
4
+
5
+ ## atMostOne() function
6
+
7
+ Verify that both properties are not specified. Returns true if only a, only b, or neither is defined. Returns false if both are defined.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export declare function atMostOne(a: any, b: any): boolean;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | a | any | The first object |
20
+ | b | any | The second object |
21
+
22
+ <b>Returns:</b>
23
+
24
+ boolean
25
+
26
+ {<!-- -->boolean<!-- -->}
27
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.authenticator._constructor_.md)
4
+
5
+ ## Authenticator.(constructor)
6
+
7
+ Create a new Authenticator instance.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ constructor();
13
+ ```
14
+
15
+ ## Exceptions
16
+
17
+ {<!-- -->Error<!-- -->} The `new` keyword was not used to create construct the authenticator.
18
+
@@ -0,0 +1,28 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.authenticator.authenticate.md)
4
+
5
+ ## Authenticator.authenticate() method
6
+
7
+ Augment the request with authentication information.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | requestOptions | AuthenticateOptions | The request to augment with authentication information. |
20
+
21
+ <b>Returns:</b>
22
+
23
+ Promise&lt;void \| Error&gt;
24
+
25
+ ## Exceptions
26
+
27
+ {<!-- -->Error<!-- -->} - The authenticate method was not implemented by a subclass.
28
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
4
+
5
+ ## Authenticator.authenticationType() method
6
+
7
+ Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the "<!-- -->&lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE" configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ authenticationType(): string;
13
+ ```
14
+ <b>Returns:</b>
15
+
16
+ string
17
+
18
+ a string that indicates the authenticator's type
19
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_BASIC property
6
+
7
+ Constants that define the various authenticator types.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ static AUTHTYPE_BASIC: string;
13
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_BEARERTOKEN property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ static AUTHTYPE_BEARERTOKEN: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_CONTAINER property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ static AUTHTYPE_CONTAINER: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_CP4D property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ static AUTHTYPE_CP4D: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_IAM property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ static AUTHTYPE_IAM: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_NOAUTH property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ static AUTHTYPE_NOAUTH: string;
11
+ ```