perimeterx-js-core 0.5.0 → 0.6.0

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 (672) hide show
  1. package/README.md +20 -15
  2. package/lib/action/Action.d.ts +6 -0
  3. package/lib/action/Action.js +7 -0
  4. package/lib/action/ActionData.d.ts +11 -0
  5. package/lib/action/ActionData.js +1 -0
  6. package/lib/action/ActionPriorityOrder.d.ts +2 -0
  7. package/lib/action/ActionPriorityOrder.js +7 -0
  8. package/lib/action/Decision.d.ts +6 -0
  9. package/lib/action/Decision.js +1 -0
  10. package/lib/action/index.d.ts +4 -0
  11. package/lib/action/index.js +4 -0
  12. package/lib/activities/ActivityType.js +2 -5
  13. package/lib/activities/HttpActivityClient.d.ts +7 -7
  14. package/lib/activities/HttpActivityClient.js +46 -95
  15. package/lib/activities/HttpBatchedActivityClient.d.ts +2 -2
  16. package/lib/activities/HttpBatchedActivityClient.js +46 -115
  17. package/lib/activities/IActivityClient.d.ts +3 -3
  18. package/lib/activities/IActivityClient.js +1 -2
  19. package/lib/activities/constants.js +1 -4
  20. package/lib/activities/index.d.ts +7 -6
  21. package/lib/activities/index.js +7 -9
  22. package/lib/activities/model/Activity.js +1 -2
  23. package/lib/activities/model/ActivityDetails.d.ts +9 -7
  24. package/lib/activities/model/ActivityDetails.js +1 -2
  25. package/lib/activities/model/index.d.ts +2 -0
  26. package/lib/activities/model/index.js +2 -0
  27. package/lib/activities/utils.d.ts +11 -8
  28. package/lib/activities/utils.js +67 -44
  29. package/lib/additional_activity_handler/AdditionalActivityHandler.d.ts +2 -2
  30. package/lib/additional_activity_handler/AdditionalActivityHandler.js +1 -2
  31. package/lib/additional_activity_handler/AdditionalActivityHandlerUtils.d.ts +2 -2
  32. package/lib/additional_activity_handler/AdditionalActivityHandlerUtils.js +11 -53
  33. package/lib/additional_activity_handler/index.d.ts +2 -2
  34. package/lib/additional_activity_handler/index.js +2 -5
  35. package/lib/{block_handler → blocker}/BlockAction.d.ts +0 -1
  36. package/lib/blocker/BlockAction.js +6 -0
  37. package/lib/blocker/BlockActionToProductMap.d.ts +3 -0
  38. package/lib/blocker/BlockActionToProductMap.js +7 -0
  39. package/lib/blocker/BlockActionToWordMap.d.ts +2 -0
  40. package/lib/blocker/BlockActionToWordMap.js +6 -0
  41. package/lib/blocker/IBlocker.d.ts +5 -0
  42. package/lib/blocker/IBlocker.js +1 -0
  43. package/lib/blocker/IConditionalBlocker.d.ts +9 -0
  44. package/lib/blocker/IConditionalBlocker.js +1 -0
  45. package/lib/blocker/index.d.ts +5 -0
  46. package/lib/blocker/index.js +5 -0
  47. package/lib/config/ConfigurationParams.d.ts +23 -10
  48. package/lib/config/ConfigurationParams.js +1 -2
  49. package/lib/config/DefaultConfigurations.d.ts +1 -1
  50. package/lib/config/DefaultConfigurations.js +19 -13
  51. package/lib/config/IConfiguration.d.ts +114 -4
  52. package/lib/config/IConfiguration.js +1 -2
  53. package/lib/config/StaticConfigurationBase.d.ts +31 -3
  54. package/lib/config/StaticConfigurationBase.js +244 -366
  55. package/lib/config/index.js +2 -7
  56. package/lib/context/DefaultContext.d.ts +46 -0
  57. package/lib/context/DefaultContext.js +82 -0
  58. package/lib/context/index.d.ts +2 -4
  59. package/lib/context/index.js +2 -20
  60. package/lib/context/interfaces/IContext.d.ts +111 -0
  61. package/lib/context/interfaces/IContext.js +1 -0
  62. package/lib/context/interfaces/MobileData.d.ts +23 -0
  63. package/lib/context/interfaces/MobileData.js +1 -0
  64. package/lib/context/interfaces/ReadonlyContext.d.ts +3 -0
  65. package/lib/context/interfaces/ReadonlyContext.js +1 -0
  66. package/lib/context/interfaces/RequestData.d.ts +41 -0
  67. package/lib/context/interfaces/RequestData.js +1 -0
  68. package/lib/context/interfaces/RiskApiData.d.ts +27 -0
  69. package/lib/context/interfaces/RiskApiData.js +1 -0
  70. package/lib/context/interfaces/ServerData.d.ts +18 -0
  71. package/lib/context/interfaces/ServerData.js +1 -0
  72. package/lib/context/interfaces/TlsData.d.ts +30 -0
  73. package/lib/context/interfaces/TlsData.js +1 -0
  74. package/lib/context/interfaces/TokenData.d.ts +16 -0
  75. package/lib/context/interfaces/TokenData.js +1 -0
  76. package/lib/context/interfaces/index.d.ts +8 -0
  77. package/lib/context/interfaces/index.js +8 -0
  78. package/lib/cors/CustomBlockResponseHeadersHandler.d.ts +2 -0
  79. package/lib/cors/CustomBlockResponseHeadersHandler.js +1 -0
  80. package/lib/cors/CustomPreflightHandler.d.ts +2 -0
  81. package/lib/cors/CustomPreflightHandler.js +1 -0
  82. package/lib/cors/DefaultCors.d.ts +15 -0
  83. package/lib/cors/DefaultCors.js +59 -0
  84. package/lib/cors/ICors.d.ts +26 -0
  85. package/lib/cors/ICors.js +1 -0
  86. package/lib/cors/constants.d.ts +2 -0
  87. package/lib/cors/constants.js +2 -0
  88. package/lib/cors/index.d.ts +5 -0
  89. package/lib/cors/index.js +2 -0
  90. package/lib/custom_parameters/CustomParameters.js +1 -2
  91. package/lib/custom_parameters/CustomParametersFunction.d.ts +1 -2
  92. package/lib/custom_parameters/CustomParametersFunction.js +1 -2
  93. package/lib/custom_parameters/CustomParametersUtils.d.ts +2 -2
  94. package/lib/custom_parameters/CustomParametersUtils.js +18 -60
  95. package/lib/custom_parameters/index.js +1 -5
  96. package/lib/enforcer/EnforcerBase.d.ts +43 -82
  97. package/lib/enforcer/EnforcerBase.js +120 -377
  98. package/lib/enforcer/IEnforcer.js +1 -2
  99. package/lib/enforcer/index.d.ts +2 -1
  100. package/lib/enforcer/index.js +2 -5
  101. package/lib/enforcer/options/EnforcerBaseOptions.d.ts +25 -0
  102. package/lib/enforcer/options/EnforcerBaseOptions.js +1 -0
  103. package/lib/enforcer/options/EnforcerOptionsType.d.ts +4 -0
  104. package/lib/enforcer/options/EnforcerOptionsType.js +1 -0
  105. package/lib/enforcer/options/EnforcerV2Options.d.ts +5 -0
  106. package/lib/enforcer/options/EnforcerV2Options.js +1 -0
  107. package/lib/enforcer/options/EnforcerV3Options.d.ts +7 -0
  108. package/lib/enforcer/options/EnforcerV3Options.js +1 -0
  109. package/lib/enforcer/options/index.d.ts +4 -0
  110. package/lib/enforcer/options/index.js +4 -0
  111. package/lib/filter/FilterReason.d.ts +2 -1
  112. package/lib/filter/FilterReason.js +3 -5
  113. package/lib/filter/IFilter.d.ts +4 -4
  114. package/lib/filter/IFilter.js +1 -2
  115. package/lib/filter/index.d.ts +2 -3
  116. package/lib/filter/index.js +2 -7
  117. package/lib/first_party/FirstPartyData.d.ts +5 -0
  118. package/lib/first_party/FirstPartyData.js +1 -0
  119. package/lib/first_party/IFirstParty.d.ts +5 -5
  120. package/lib/first_party/IFirstParty.js +1 -2
  121. package/lib/first_party/index.d.ts +2 -4
  122. package/lib/first_party/index.js +2 -21
  123. package/lib/graphql/DefaultGraphQLParser.d.ts +7 -6
  124. package/lib/graphql/DefaultGraphQLParser.js +78 -131
  125. package/lib/graphql/IGraphQLParser.d.ts +5 -4
  126. package/lib/graphql/IGraphQLParser.js +1 -2
  127. package/lib/graphql/index.d.ts +3 -5
  128. package/lib/graphql/index.js +3 -7
  129. package/lib/graphql/model/GraphQLData.js +1 -2
  130. package/lib/graphql/model/GraphQLOperation.js +1 -2
  131. package/lib/graphql/model/GraphQLOperationType.js +2 -5
  132. package/lib/graphql/model/index.d.ts +3 -0
  133. package/lib/graphql/model/index.js +3 -0
  134. package/lib/http/impl/FormDataImpl.d.ts +12 -0
  135. package/lib/http/impl/FormDataImpl.js +36 -0
  136. package/lib/http/impl/MinimalResponseImpl.d.ts +3 -3
  137. package/lib/http/impl/MinimalResponseImpl.js +3 -8
  138. package/lib/http/impl/OutgoingRequestImpl.d.ts +3 -3
  139. package/lib/http/impl/OutgoingRequestImpl.js +5 -10
  140. package/lib/http/impl/index.d.ts +1 -0
  141. package/lib/http/impl/index.js +4 -19
  142. package/lib/http/impl/phin/PhinHttpClient.js +30 -70
  143. package/lib/http/impl/phin/PhinIncomingResponse.d.ts +4 -5
  144. package/lib/http/impl/phin/PhinIncomingResponse.js +22 -70
  145. package/lib/http/impl/phin/index.js +2 -18
  146. package/lib/http/index.js +3 -19
  147. package/lib/http/interfaces/IBody.d.ts +10 -12
  148. package/lib/http/interfaces/IBody.js +1 -2
  149. package/lib/http/interfaces/IFormData.d.ts +9 -0
  150. package/lib/http/interfaces/IFormData.js +1 -0
  151. package/lib/http/interfaces/IHeaders.js +1 -2
  152. package/lib/http/interfaces/IHttpClient.js +1 -2
  153. package/lib/http/interfaces/IIncomingRequest.d.ts +10 -6
  154. package/lib/http/interfaces/IIncomingRequest.js +1 -2
  155. package/lib/http/interfaces/IIncomingResponse.d.ts +2 -2
  156. package/lib/http/interfaces/IIncomingResponse.js +1 -2
  157. package/lib/http/interfaces/IMinimalResponse.d.ts +2 -2
  158. package/lib/http/interfaces/IMinimalResponse.js +1 -2
  159. package/lib/http/interfaces/IOutgoingRequest.d.ts +2 -2
  160. package/lib/http/interfaces/IOutgoingRequest.js +1 -2
  161. package/lib/http/interfaces/IOutgoingResponse.d.ts +5 -1
  162. package/lib/http/interfaces/IOutgoingResponse.js +1 -2
  163. package/lib/http/interfaces/IURL.d.ts +6 -0
  164. package/lib/http/interfaces/IURL.js +1 -0
  165. package/lib/http/interfaces/ReadonlyHeaders.d.ts +6 -0
  166. package/lib/http/interfaces/ReadonlyHeaders.js +14 -0
  167. package/lib/http/interfaces/index.d.ts +3 -1
  168. package/lib/http/interfaces/index.js +11 -25
  169. package/lib/http/utils/ContentType.js +2 -5
  170. package/lib/http/utils/HttpMethod.js +2 -5
  171. package/lib/http/utils/MinimalResponseUtils.d.ts +6 -4
  172. package/lib/http/utils/MinimalResponseUtils.js +31 -38
  173. package/lib/http/utils/MultipartFormDataUtils.d.ts +6 -0
  174. package/lib/http/utils/MultipartFormDataUtils.js +45 -0
  175. package/lib/http/utils/constants.js +9 -12
  176. package/lib/http/utils/index.d.ts +3 -1
  177. package/lib/http/utils/index.js +5 -21
  178. package/lib/index.d.ts +5 -1
  179. package/lib/index.js +22 -34
  180. package/lib/logger/DefaultLogger.js +7 -28
  181. package/lib/logger/ILogger.js +1 -2
  182. package/lib/logger/LoggerBase.d.ts +2 -0
  183. package/lib/logger/LoggerBase.js +24 -22
  184. package/lib/logger/LoggerSeverity.js +2 -5
  185. package/lib/logger/index.js +3 -9
  186. package/lib/phase/IPhase.d.ts +5 -0
  187. package/lib/phase/IPhase.js +1 -0
  188. package/lib/phase/PhaseResult.d.ts +5 -0
  189. package/lib/phase/PhaseResult.js +1 -0
  190. package/lib/phase/flow/EnforceFlow.d.ts +6 -0
  191. package/lib/phase/flow/EnforceFlow.js +15 -0
  192. package/lib/phase/flow/FilterFlow.d.ts +6 -0
  193. package/lib/phase/flow/FilterFlow.js +12 -0
  194. package/lib/phase/flow/PostEnforceFlow.d.ts +6 -0
  195. package/lib/phase/flow/PostEnforceFlow.js +10 -0
  196. package/lib/phase/flow/index.d.ts +3 -0
  197. package/lib/phase/flow/index.js +3 -0
  198. package/lib/phase/impl/AdditionalActivityHandlerPhase.d.ts +9 -0
  199. package/lib/phase/impl/AdditionalActivityHandlerPhase.js +22 -0
  200. package/lib/phase/impl/CompositePhase.d.ts +8 -0
  201. package/lib/phase/impl/CompositePhase.js +26 -0
  202. package/lib/phase/impl/CreateBlockResponsePhase.d.ts +17 -0
  203. package/lib/phase/impl/CreateBlockResponsePhase.js +60 -0
  204. package/lib/phase/impl/DecideActionPhase.d.ts +19 -0
  205. package/lib/phase/impl/DecideActionPhase.js +56 -0
  206. package/lib/phase/impl/EnrichContextFromRequestPhase.d.ts +18 -0
  207. package/lib/phase/impl/EnrichContextFromRequestPhase.js +59 -0
  208. package/lib/phase/impl/EnrichContextFromResponsePhase.d.ts +10 -0
  209. package/lib/phase/impl/EnrichContextFromResponsePhase.js +29 -0
  210. package/lib/phase/impl/FilterPhase.d.ts +9 -0
  211. package/lib/phase/impl/FilterPhase.js +19 -0
  212. package/lib/phase/impl/FirstPartyPhase.d.ts +12 -0
  213. package/lib/phase/impl/FirstPartyPhase.js +42 -0
  214. package/lib/phase/impl/ModifyIncomingRequestPhase.d.ts +9 -0
  215. package/lib/phase/impl/ModifyIncomingRequestPhase.js +20 -0
  216. package/lib/phase/impl/ModifyOutgoingResponsePhase.d.ts +9 -0
  217. package/lib/phase/impl/ModifyOutgoingResponsePhase.js +25 -0
  218. package/lib/phase/impl/ParseTokenPhase.d.ts +10 -0
  219. package/lib/phase/impl/ParseTokenPhase.js +37 -0
  220. package/lib/phase/impl/PreflightPhase.d.ts +12 -0
  221. package/lib/phase/impl/PreflightPhase.js +28 -0
  222. package/lib/phase/impl/RiskApiPhase.d.ts +17 -0
  223. package/lib/phase/impl/RiskApiPhase.js +76 -0
  224. package/lib/phase/impl/SendAsyncActivitiesOnRequestPhase.d.ts +10 -0
  225. package/lib/phase/impl/SendAsyncActivitiesOnRequestPhase.js +28 -0
  226. package/lib/phase/impl/SendAsyncActivitiesOnResponsePhase.d.ts +9 -0
  227. package/lib/phase/impl/SendAsyncActivitiesOnResponsePhase.js +20 -0
  228. package/lib/phase/impl/TelemetryPhase.d.ts +10 -0
  229. package/lib/phase/impl/TelemetryPhase.js +29 -0
  230. package/lib/phase/impl/index.d.ts +16 -0
  231. package/lib/phase/impl/index.js +16 -0
  232. package/lib/phase/index.d.ts +4 -0
  233. package/lib/phase/index.js +4 -0
  234. package/lib/products/account_defender/AccountDefender.d.ts +23 -0
  235. package/lib/products/account_defender/AccountDefender.js +98 -0
  236. package/lib/products/account_defender/AccountDefenderData.d.ts +6 -0
  237. package/lib/products/account_defender/AccountDefenderData.js +1 -0
  238. package/lib/products/account_defender/IAccountDefender.d.ts +4 -0
  239. package/lib/products/account_defender/IAccountDefender.js +1 -0
  240. package/lib/products/account_defender/JwtData.d.ts +4 -0
  241. package/lib/products/account_defender/JwtData.js +1 -0
  242. package/lib/products/account_defender/constants.d.ts +1 -0
  243. package/lib/products/account_defender/constants.js +1 -0
  244. package/lib/products/account_defender/index.d.ts +5 -0
  245. package/lib/products/account_defender/index.js +5 -0
  246. package/lib/products/bot_defender/BotDefender.d.ts +47 -0
  247. package/lib/products/bot_defender/BotDefender.js +135 -0
  248. package/lib/products/bot_defender/BotDefenderActionData.d.ts +7 -0
  249. package/lib/products/bot_defender/BotDefenderActionData.js +6 -0
  250. package/lib/products/bot_defender/BotDefenderData.d.ts +13 -0
  251. package/lib/products/bot_defender/BotDefenderData.js +1 -0
  252. package/lib/products/bot_defender/BotDefenderUtils.d.ts +5 -0
  253. package/lib/products/bot_defender/BotDefenderUtils.js +19 -0
  254. package/lib/products/bot_defender/IBotDefender.d.ts +7 -0
  255. package/lib/products/bot_defender/IBotDefender.js +1 -0
  256. package/lib/products/bot_defender/block/DefaultBotDefenderBlocker.d.ts +14 -0
  257. package/lib/products/bot_defender/block/DefaultBotDefenderBlocker.js +39 -0
  258. package/lib/products/bot_defender/block/captcha/CaptchaBlocker.d.ts +13 -0
  259. package/lib/products/bot_defender/block/captcha/CaptchaBlocker.js +20 -0
  260. package/lib/products/bot_defender/block/captcha/HtmlCaptchaBlocker.d.ts +9 -0
  261. package/lib/products/bot_defender/block/captcha/HtmlCaptchaBlocker.js +20 -0
  262. package/lib/products/bot_defender/block/captcha/JsonCaptchaBlocker.d.ts +10 -0
  263. package/lib/products/bot_defender/block/captcha/JsonCaptchaBlocker.js +38 -0
  264. package/lib/products/bot_defender/block/captcha/MobileCaptchaBlocker.d.ts +12 -0
  265. package/lib/products/bot_defender/block/captcha/MobileCaptchaBlocker.js +34 -0
  266. package/lib/products/bot_defender/block/captcha/index.d.ts +4 -0
  267. package/lib/products/bot_defender/block/captcha/index.js +4 -0
  268. package/lib/products/bot_defender/block/index.d.ts +5 -0
  269. package/lib/products/bot_defender/block/index.js +5 -0
  270. package/lib/{block_handler → products/bot_defender/block}/model/BlockData.d.ts +1 -1
  271. package/lib/products/bot_defender/block/model/BlockData.js +1 -0
  272. package/lib/products/bot_defender/block/model/JsonBlockPayload.js +1 -0
  273. package/lib/products/bot_defender/block/model/MobileBlockPayload.js +1 -0
  274. package/lib/products/bot_defender/block/model/index.d.ts +3 -0
  275. package/lib/products/bot_defender/block/model/index.js +3 -0
  276. package/lib/products/bot_defender/block/templates/captcha_template.js +50 -0
  277. package/lib/products/bot_defender/block/templates/index.d.ts +2 -0
  278. package/lib/products/bot_defender/block/templates/index.js +2 -0
  279. package/lib/products/bot_defender/block/templates/rate_limit_template.js +10 -0
  280. package/lib/products/bot_defender/block/utils.d.ts +5 -0
  281. package/lib/products/bot_defender/block/utils.js +43 -0
  282. package/lib/products/bot_defender/filter/DefaultBotDefenderFilter.d.ts +16 -0
  283. package/lib/products/bot_defender/filter/DefaultBotDefenderFilter.js +51 -0
  284. package/lib/products/bot_defender/filter/index.d.ts +1 -0
  285. package/lib/products/bot_defender/filter/index.js +1 -0
  286. package/lib/products/bot_defender/first_party/DefaultBotDefenderFirstParty.d.ts +20 -0
  287. package/lib/products/bot_defender/first_party/DefaultBotDefenderFirstParty.js +129 -0
  288. package/lib/products/bot_defender/first_party/FirstPartySuffix.d.ts +5 -0
  289. package/lib/products/bot_defender/first_party/FirstPartySuffix.js +6 -0
  290. package/lib/{first_party → products/bot_defender/first_party}/constants.d.ts +5 -2
  291. package/lib/products/bot_defender/first_party/constants.js +36 -0
  292. package/lib/products/bot_defender/first_party/index.d.ts +4 -0
  293. package/lib/products/bot_defender/first_party/index.js +4 -0
  294. package/lib/products/bot_defender/first_party/utils.d.ts +11 -0
  295. package/lib/products/bot_defender/first_party/utils.js +46 -0
  296. package/lib/products/bot_defender/index.d.ts +9 -0
  297. package/lib/products/bot_defender/index.js +9 -0
  298. package/lib/{block_handler/BlockReason.d.ts → products/bot_defender/reasons/BotDefenderBlockReason.d.ts} +1 -1
  299. package/lib/products/bot_defender/reasons/BotDefenderBlockReason.js +5 -0
  300. package/lib/{utils/PassReason.d.ts → products/bot_defender/reasons/BotDefenderPassReason.d.ts} +1 -1
  301. package/lib/products/bot_defender/reasons/BotDefenderPassReason.js +7 -0
  302. package/lib/products/bot_defender/reasons/BotDefenderReasonType.d.ts +5 -0
  303. package/lib/products/bot_defender/reasons/BotDefenderReasonType.js +1 -0
  304. package/lib/{risk_api/S2SCallReason.d.ts → products/bot_defender/reasons/BotDefenderS2SCallReason.d.ts} +1 -1
  305. package/lib/products/bot_defender/reasons/BotDefenderS2SCallReason.js +13 -0
  306. package/lib/products/bot_defender/reasons/index.d.ts +4 -0
  307. package/lib/products/bot_defender/reasons/index.js +4 -0
  308. package/lib/products/credential_intelligence/CredentialIntelligence.d.ts +22 -0
  309. package/lib/products/credential_intelligence/CredentialIntelligence.js +96 -0
  310. package/lib/products/credential_intelligence/ICredentialIntelligence.d.ts +4 -0
  311. package/lib/products/credential_intelligence/ICredentialIntelligence.js +1 -0
  312. package/lib/products/credential_intelligence/constants.d.ts +4 -0
  313. package/lib/products/credential_intelligence/constants.js +4 -0
  314. package/lib/products/credential_intelligence/endpoint/CredentialEndpoint.d.ts +21 -0
  315. package/lib/products/credential_intelligence/endpoint/CredentialEndpoint.js +37 -0
  316. package/lib/products/credential_intelligence/endpoint/CredentialEndpointConfiguration.d.ts +74 -0
  317. package/lib/products/credential_intelligence/endpoint/CredentialEndpointConfiguration.js +1 -0
  318. package/lib/products/credential_intelligence/endpoint/CredentialEndpointManager.d.ts +12 -0
  319. package/lib/products/credential_intelligence/endpoint/CredentialEndpointManager.js +32 -0
  320. package/lib/products/credential_intelligence/endpoint/ICredentialEndpoint.d.ts +9 -0
  321. package/lib/products/credential_intelligence/endpoint/ICredentialEndpoint.js +1 -0
  322. package/lib/products/credential_intelligence/endpoint/extractor/BodyCredentialExtractor.d.ts +15 -0
  323. package/lib/products/credential_intelligence/endpoint/extractor/BodyCredentialExtractor.js +64 -0
  324. package/lib/products/credential_intelligence/endpoint/extractor/CredentialExtractorFactory.d.ts +5 -0
  325. package/lib/products/credential_intelligence/endpoint/extractor/CredentialExtractorFactory.js +21 -0
  326. package/lib/products/credential_intelligence/endpoint/extractor/CustomCredentialExtractor.d.ts +9 -0
  327. package/lib/products/credential_intelligence/endpoint/extractor/CustomCredentialExtractor.js +24 -0
  328. package/lib/products/credential_intelligence/endpoint/extractor/HeaderCredentialExtractor.d.ts +10 -0
  329. package/lib/products/credential_intelligence/endpoint/extractor/HeaderCredentialExtractor.js +22 -0
  330. package/lib/products/credential_intelligence/endpoint/extractor/ICredentialExtractor.d.ts +6 -0
  331. package/lib/products/credential_intelligence/endpoint/extractor/ICredentialExtractor.js +1 -0
  332. package/lib/products/credential_intelligence/endpoint/extractor/QueryParamCredentialExtractor.d.ts +10 -0
  333. package/lib/products/credential_intelligence/endpoint/extractor/QueryParamCredentialExtractor.js +23 -0
  334. package/lib/products/credential_intelligence/endpoint/extractor/SentThrough.d.ts +6 -0
  335. package/lib/products/credential_intelligence/endpoint/extractor/SentThrough.js +7 -0
  336. package/lib/products/credential_intelligence/endpoint/extractor/index.d.ts +5 -0
  337. package/lib/products/credential_intelligence/endpoint/extractor/index.js +5 -0
  338. package/lib/products/credential_intelligence/endpoint/hash_protocol/CredentialIntelligenceHashProtocolFactory.d.ts +6 -0
  339. package/lib/products/credential_intelligence/endpoint/hash_protocol/CredentialIntelligenceHashProtocolFactory.js +17 -0
  340. package/lib/products/credential_intelligence/endpoint/hash_protocol/CredentialIntelligenceVersion.d.ts +5 -0
  341. package/lib/products/credential_intelligence/endpoint/hash_protocol/CredentialIntelligenceVersion.js +6 -0
  342. package/lib/products/credential_intelligence/endpoint/hash_protocol/ICredentialIntelligenceHashProtocol.d.ts +5 -0
  343. package/lib/products/credential_intelligence/endpoint/hash_protocol/ICredentialIntelligenceHashProtocol.js +1 -0
  344. package/lib/products/credential_intelligence/endpoint/hash_protocol/MultistepHashProtocol.d.ts +8 -0
  345. package/lib/products/credential_intelligence/endpoint/hash_protocol/MultistepHashProtocol.js +30 -0
  346. package/lib/products/credential_intelligence/endpoint/hash_protocol/SingleStepAndMultistepHashProtocol.d.ts +8 -0
  347. package/lib/products/credential_intelligence/endpoint/hash_protocol/SingleStepAndMultistepHashProtocol.js +25 -0
  348. package/lib/products/credential_intelligence/endpoint/hash_protocol/SingleStepHashProtocol.d.ts +10 -0
  349. package/lib/products/credential_intelligence/endpoint/hash_protocol/SingleStepHashProtocol.js +49 -0
  350. package/lib/products/credential_intelligence/endpoint/hash_protocol/SsoStep.d.ts +4 -0
  351. package/lib/products/credential_intelligence/endpoint/hash_protocol/SsoStep.js +5 -0
  352. package/lib/products/credential_intelligence/endpoint/hash_protocol/index.d.ts +7 -0
  353. package/lib/products/credential_intelligence/endpoint/hash_protocol/index.js +7 -0
  354. package/lib/products/credential_intelligence/endpoint/index.d.ts +8 -0
  355. package/lib/products/credential_intelligence/endpoint/index.js +8 -0
  356. package/lib/products/credential_intelligence/endpoint/login_successful/BodyLoginSuccessfulParser.d.ts +7 -0
  357. package/lib/products/credential_intelligence/endpoint/login_successful/BodyLoginSuccessfulParser.js +20 -0
  358. package/lib/products/credential_intelligence/endpoint/login_successful/CustomLoginSuccessfulCallback.d.ts +1 -0
  359. package/lib/products/credential_intelligence/endpoint/login_successful/CustomLoginSuccessfulCallback.js +1 -0
  360. package/lib/products/credential_intelligence/endpoint/login_successful/CustomLoginSuccessfulParser.d.ts +8 -0
  361. package/lib/products/credential_intelligence/endpoint/login_successful/CustomLoginSuccessfulParser.js +26 -0
  362. package/lib/products/credential_intelligence/endpoint/login_successful/HeaderLoginSuccessfulParser.d.ts +8 -0
  363. package/lib/products/credential_intelligence/endpoint/login_successful/HeaderLoginSuccessfulParser.js +23 -0
  364. package/lib/products/credential_intelligence/endpoint/login_successful/ILoginSuccessfulParser.d.ts +4 -0
  365. package/lib/products/credential_intelligence/endpoint/login_successful/ILoginSuccessfulParser.js +1 -0
  366. package/lib/products/credential_intelligence/endpoint/login_successful/LoginSuccessfulParserFactory.d.ts +6 -0
  367. package/lib/products/credential_intelligence/endpoint/login_successful/LoginSuccessfulParserFactory.js +26 -0
  368. package/lib/products/credential_intelligence/endpoint/login_successful/LoginSuccessfulReportingMethod.d.ts +6 -0
  369. package/lib/products/credential_intelligence/endpoint/login_successful/LoginSuccessfulReportingMethod.js +7 -0
  370. package/lib/products/credential_intelligence/endpoint/login_successful/StatusLoginSuccessfulParser.d.ts +7 -0
  371. package/lib/products/credential_intelligence/endpoint/login_successful/StatusLoginSuccessfulParser.js +19 -0
  372. package/lib/products/credential_intelligence/endpoint/login_successful/index.d.ts +8 -0
  373. package/lib/products/credential_intelligence/endpoint/login_successful/index.js +8 -0
  374. package/lib/products/credential_intelligence/endpoint/matcher/CredentialIntelligenceEndpointMatcherFactory.d.ts +5 -0
  375. package/lib/products/credential_intelligence/endpoint/matcher/CredentialIntelligenceEndpointMatcherFactory.js +14 -0
  376. package/lib/products/credential_intelligence/endpoint/matcher/ExactPathEndpointMatcher.d.ts +10 -0
  377. package/lib/products/credential_intelligence/endpoint/matcher/ExactPathEndpointMatcher.js +9 -0
  378. package/lib/products/credential_intelligence/endpoint/matcher/ICredentialIntelligenceEndpointMatcher.d.ts +5 -0
  379. package/lib/products/credential_intelligence/endpoint/matcher/ICredentialIntelligenceEndpointMatcher.js +1 -0
  380. package/lib/products/credential_intelligence/endpoint/matcher/PathType.d.ts +4 -0
  381. package/lib/products/credential_intelligence/endpoint/matcher/PathType.js +5 -0
  382. package/lib/products/credential_intelligence/endpoint/matcher/RegexPathEndpointMatcher.d.ts +10 -0
  383. package/lib/products/credential_intelligence/endpoint/matcher/RegexPathEndpointMatcher.js +9 -0
  384. package/lib/products/credential_intelligence/endpoint/matcher/index.d.ts +5 -0
  385. package/lib/products/credential_intelligence/endpoint/matcher/index.js +5 -0
  386. package/lib/products/credential_intelligence/index.d.ts +5 -0
  387. package/lib/products/credential_intelligence/index.js +5 -0
  388. package/lib/products/credential_intelligence/model/CredentialData.d.ts +8 -0
  389. package/lib/products/credential_intelligence/model/CredentialData.js +1 -0
  390. package/lib/products/credential_intelligence/model/CredentialIntelligenceData.d.ts +7 -0
  391. package/lib/products/credential_intelligence/model/CredentialIntelligenceData.js +1 -0
  392. package/lib/products/credential_intelligence/model/Credentials.d.ts +4 -0
  393. package/lib/products/credential_intelligence/model/Credentials.js +1 -0
  394. package/lib/products/credential_intelligence/model/CustomExtractionCallback.d.ts +2 -0
  395. package/lib/products/credential_intelligence/model/CustomExtractionCallback.js +1 -0
  396. package/lib/products/credential_intelligence/model/index.d.ts +4 -0
  397. package/lib/products/credential_intelligence/model/index.js +4 -0
  398. package/lib/products/index.d.ts +5 -0
  399. package/lib/products/index.js +5 -0
  400. package/lib/products/interfaces/IProduct.d.ts +10 -0
  401. package/lib/products/interfaces/IProduct.js +1 -0
  402. package/lib/products/interfaces/ProductData.d.ts +5 -0
  403. package/lib/products/interfaces/ProductData.js +1 -0
  404. package/lib/products/interfaces/ProductDataType.d.ts +5 -0
  405. package/lib/products/interfaces/ProductDataType.js +1 -0
  406. package/lib/products/interfaces/ProductType.d.ts +5 -0
  407. package/lib/products/interfaces/ProductType.js +1 -0
  408. package/lib/products/interfaces/Products.d.ts +5 -0
  409. package/lib/products/interfaces/Products.js +1 -0
  410. package/lib/products/interfaces/index.d.ts +5 -0
  411. package/lib/products/interfaces/index.js +5 -0
  412. package/lib/products/utils/ProductName.d.ts +7 -0
  413. package/lib/products/utils/ProductName.js +8 -0
  414. package/lib/products/utils/ProductPriorityOrder.d.ts +2 -0
  415. package/lib/products/utils/ProductPriorityOrder.js +8 -0
  416. package/lib/products/utils/index.d.ts +3 -0
  417. package/lib/products/utils/index.js +3 -0
  418. package/lib/products/utils/utils.d.ts +5 -0
  419. package/lib/products/utils/utils.js +12 -0
  420. package/lib/pxde/DefaultDataEnrichment.d.ts +7 -6
  421. package/lib/pxde/DefaultDataEnrichment.js +57 -116
  422. package/lib/pxde/IDataEnrichment.d.ts +5 -4
  423. package/lib/pxde/IDataEnrichment.js +1 -2
  424. package/lib/pxde/constants.js +4 -7
  425. package/lib/pxde/index.d.ts +3 -3
  426. package/lib/pxde/index.js +4 -20
  427. package/lib/pxde/model/PXDE.js +1 -2
  428. package/lib/pxde/model/PxdeData.d.ts +5 -0
  429. package/lib/pxde/model/PxdeData.js +1 -0
  430. package/lib/pxde/model/index.d.ts +2 -0
  431. package/lib/pxde/model/index.js +2 -0
  432. package/lib/pxhd/PXHDUtils.d.ts +5 -5
  433. package/lib/pxhd/PXHDUtils.js +16 -23
  434. package/lib/pxhd/index.d.ts +1 -0
  435. package/lib/pxhd/index.js +2 -5
  436. package/lib/pxhd/model/PXHD.d.ts +6 -0
  437. package/lib/pxhd/model/PXHD.js +1 -0
  438. package/lib/pxhd/model/PXHDSource.d.ts +4 -0
  439. package/lib/pxhd/model/PXHDSource.js +5 -0
  440. package/lib/pxhd/model/index.d.ts +2 -0
  441. package/lib/pxhd/model/index.js +2 -0
  442. package/lib/risk_api/client/IRiskApiClient.d.ts +4 -0
  443. package/lib/risk_api/client/IRiskApiClient.js +1 -0
  444. package/lib/risk_api/client/PostRiskApiClientBase.d.ts +44 -0
  445. package/lib/risk_api/client/PostRiskApiClientBase.js +235 -0
  446. package/lib/risk_api/client/PostRiskApiClientV2.d.ts +8 -0
  447. package/lib/risk_api/client/PostRiskApiClientV2.js +10 -0
  448. package/lib/risk_api/client/PostRiskApiClientV3.d.ts +8 -0
  449. package/lib/risk_api/client/PostRiskApiClientV3.js +10 -0
  450. package/lib/risk_api/client/index.d.ts +4 -0
  451. package/lib/risk_api/client/index.js +4 -0
  452. package/lib/risk_api/constants.js +1 -4
  453. package/lib/risk_api/index.d.ts +3 -12
  454. package/lib/risk_api/index.js +4 -34
  455. package/lib/risk_api/model/RiskActivity.d.ts +6 -2
  456. package/lib/risk_api/model/RiskActivity.js +1 -2
  457. package/lib/risk_api/model/RiskApiCallResult.d.ts +6 -0
  458. package/lib/risk_api/model/RiskApiCallResult.js +7 -0
  459. package/lib/risk_api/model/RiskStatus.js +2 -5
  460. package/lib/risk_api/{S2SErrorReason.js → model/S2SErrorReason.js} +2 -5
  461. package/lib/risk_api/model/index.d.ts +4 -0
  462. package/lib/risk_api/model/index.js +4 -0
  463. package/lib/risk_api/risk_response/IRiskResponse.d.ts +15 -0
  464. package/lib/risk_api/risk_response/IRiskResponse.js +1 -0
  465. package/lib/risk_api/risk_response/RiskResponseBase.d.ts +22 -0
  466. package/lib/risk_api/risk_response/RiskResponseBase.js +54 -0
  467. package/lib/risk_api/risk_response/RiskResponsePayloadType.d.ts +4 -0
  468. package/lib/risk_api/risk_response/RiskResponsePayloadType.js +1 -0
  469. package/lib/risk_api/risk_response/index.d.ts +4 -0
  470. package/lib/risk_api/risk_response/index.js +4 -0
  471. package/lib/risk_api/risk_response/v2/DefaultRiskResponseV2.d.ts +8 -0
  472. package/lib/risk_api/risk_response/v2/DefaultRiskResponseV2.js +18 -0
  473. package/lib/risk_api/risk_response/v2/RiskResponseV2Payload.d.ts +13 -0
  474. package/lib/risk_api/risk_response/v2/RiskResponseV2Payload.js +1 -0
  475. package/lib/risk_api/risk_response/v2/index.d.ts +2 -0
  476. package/lib/risk_api/risk_response/v2/index.js +2 -0
  477. package/lib/risk_api/risk_response/v3/DefaultRiskResponseV3.d.ts +8 -0
  478. package/lib/risk_api/risk_response/v3/DefaultRiskResponseV3.js +14 -0
  479. package/lib/risk_api/risk_response/v3/RiskResponseV3Payload.d.ts +13 -0
  480. package/lib/risk_api/risk_response/v3/RiskResponseV3Payload.js +1 -0
  481. package/lib/risk_api/risk_response/v3/index.d.ts +2 -0
  482. package/lib/risk_api/risk_response/v3/index.js +2 -0
  483. package/lib/risk_token/MobileError.js +2 -5
  484. package/lib/risk_token/TokenOrigin.js +2 -5
  485. package/lib/risk_token/{TokenVerificationResult.d.ts → TokenParseResult.d.ts} +2 -2
  486. package/lib/risk_token/TokenParseResult.js +7 -0
  487. package/lib/risk_token/TokenVersion.js +2 -5
  488. package/lib/risk_token/constants.js +9 -12
  489. package/lib/risk_token/index.d.ts +2 -3
  490. package/lib/risk_token/index.js +8 -32
  491. package/lib/risk_token/parser/DefaultTokenV2Parser.d.ts +13 -0
  492. package/lib/risk_token/parser/DefaultTokenV2Parser.js +14 -0
  493. package/lib/risk_token/parser/DefaultTokenV3Parser.d.ts +13 -0
  494. package/lib/risk_token/parser/DefaultTokenV3Parser.js +14 -0
  495. package/lib/risk_token/parser/ITokenParser.d.ts +4 -0
  496. package/lib/risk_token/parser/ITokenParser.js +1 -0
  497. package/lib/risk_token/parser/TokenParserBase.d.ts +19 -0
  498. package/lib/risk_token/parser/TokenParserBase.js +94 -0
  499. package/lib/risk_token/parser/TokenParserOptions.d.ts +4 -0
  500. package/lib/risk_token/parser/TokenParserOptions.js +1 -0
  501. package/lib/risk_token/parser/index.d.ts +5 -0
  502. package/lib/risk_token/parser/index.js +5 -0
  503. package/lib/risk_token/token/{IBotDefenderToken.d.ts → IToken.d.ts} +10 -9
  504. package/lib/risk_token/token/IToken.js +1 -0
  505. package/lib/risk_token/token/TokenBase.d.ts +32 -0
  506. package/lib/risk_token/token/TokenBase.js +50 -0
  507. package/lib/risk_token/token/TokenPayloadType.d.ts +4 -0
  508. package/lib/risk_token/token/TokenPayloadType.js +1 -0
  509. package/lib/risk_token/token/index.d.ts +6 -6
  510. package/lib/risk_token/token/index.js +4 -11
  511. package/lib/risk_token/token/v2/DefaultTokenV2.d.ts +27 -0
  512. package/lib/risk_token/token/v2/DefaultTokenV2.js +112 -0
  513. package/lib/risk_token/token/v2/{BotDefenderTokenV2Payload.d.ts → TokenV2Payload.d.ts} +1 -1
  514. package/lib/risk_token/token/v2/TokenV2Payload.js +1 -0
  515. package/lib/risk_token/token/v3/DefaultTokenV3.d.ts +30 -0
  516. package/lib/risk_token/token/v3/DefaultTokenV3.js +137 -0
  517. package/lib/risk_token/token/v3/TokenSignField.js +2 -5
  518. package/lib/risk_token/token/v3/TokenV3Payload.d.ts +9 -0
  519. package/lib/risk_token/token/v3/TokenV3Payload.js +1 -0
  520. package/lib/risk_token/utils.js +7 -11
  521. package/lib/telemetry/DefaultTelemetry.d.ts +8 -8
  522. package/lib/telemetry/DefaultTelemetry.js +86 -152
  523. package/lib/telemetry/ITelemetry.d.ts +4 -4
  524. package/lib/telemetry/ITelemetry.js +1 -2
  525. package/lib/telemetry/constants.js +7 -10
  526. package/lib/telemetry/index.js +2 -20
  527. package/lib/telemetry/model/TelemetryActivity.d.ts +1 -1
  528. package/lib/telemetry/model/TelemetryActivity.js +1 -2
  529. package/lib/utils/Algorithm.js +2 -5
  530. package/lib/utils/ModuleMode.js +2 -5
  531. package/lib/utils/VidSource.js +2 -5
  532. package/lib/utils/base64/AtobBase64Utils.js +6 -13
  533. package/lib/utils/base64/BufferBase64Utils.js +9 -16
  534. package/lib/utils/base64/IBase64Utils.js +1 -2
  535. package/lib/utils/base64/JSBase64Base64Utils.js +8 -15
  536. package/lib/utils/base64/index.js +4 -20
  537. package/lib/utils/cipher/CryptoCipherUtils.d.ts +1 -3
  538. package/lib/utils/cipher/CryptoCipherUtils.js +16 -53
  539. package/lib/utils/cipher/ICipherUtils.d.ts +2 -1
  540. package/lib/utils/cipher/ICipherUtils.js +1 -2
  541. package/lib/utils/cipher/SubtleCryptoCipherUtils.js +31 -78
  542. package/lib/utils/cipher/index.js +2 -18
  543. package/lib/utils/constants.d.ts +2 -1
  544. package/lib/utils/constants.js +11 -13
  545. package/lib/utils/cookie_parser/ICookieParser.js +1 -2
  546. package/lib/utils/cookie_parser/{DefaultCookieParser.d.ts → StringSplitCookieParser.d.ts} +2 -1
  547. package/lib/utils/cookie_parser/StringSplitCookieParser.js +28 -0
  548. package/lib/utils/cookie_parser/index.d.ts +2 -2
  549. package/lib/utils/cookie_parser/index.js +2 -5
  550. package/lib/utils/error/EnforcerError.js +6 -28
  551. package/lib/utils/error/EnforcerErrorName.js +2 -5
  552. package/lib/utils/error/EnforcerTimeoutError.js +7 -29
  553. package/lib/utils/error/index.js +3 -9
  554. package/lib/utils/hash/CryptoHashUtils.d.ts +11 -0
  555. package/lib/utils/hash/CryptoHashUtils.js +20 -0
  556. package/lib/utils/hash/IHashUtils.d.ts +2 -1
  557. package/lib/utils/hash/IHashUtils.js +1 -2
  558. package/lib/utils/hash/SubtleCryptoHashUtils.d.ts +8 -0
  559. package/lib/utils/hash/SubtleCryptoHashUtils.js +31 -0
  560. package/lib/utils/hash/index.d.ts +2 -2
  561. package/lib/utils/hash/index.js +3 -19
  562. package/lib/utils/{hash → hmac}/CryptoHmacUtils.d.ts +2 -2
  563. package/lib/utils/hmac/CryptoHmacUtils.js +19 -0
  564. package/lib/utils/{hash → hmac}/CryptoJSHmacUtils.d.ts +2 -2
  565. package/lib/utils/hmac/CryptoJSHmacUtils.js +12 -0
  566. package/lib/utils/hmac/IHmacUtils.d.ts +4 -0
  567. package/lib/utils/hmac/IHmacUtils.js +1 -0
  568. package/lib/utils/hmac/index.d.ts +3 -0
  569. package/lib/utils/hmac/index.js +3 -0
  570. package/lib/utils/index.d.ts +5 -6
  571. package/lib/utils/index.js +13 -34
  572. package/lib/utils/ip_range_checker/DefaultIpRangeChecker.js +5 -12
  573. package/lib/utils/ip_range_checker/IIpRangeChecker.js +1 -2
  574. package/lib/utils/ip_range_checker/index.js +1 -5
  575. package/lib/utils/request_id_generator/IRequestIdGenerator.d.ts +3 -0
  576. package/lib/utils/request_id_generator/IRequestIdGenerator.js +1 -0
  577. package/lib/utils/request_id_generator/UuidRequestIdGenerator.d.ts +4 -0
  578. package/lib/utils/request_id_generator/UuidRequestIdGenerator.js +6 -0
  579. package/lib/utils/request_id_generator/index.d.ts +2 -0
  580. package/lib/utils/request_id_generator/index.js +1 -0
  581. package/lib/utils/utils.d.ts +8 -2
  582. package/lib/utils/utils.js +55 -97
  583. package/package.json +5 -2
  584. package/lib/block_handler/BlockAction.js +0 -21
  585. package/lib/block_handler/BlockReason.js +0 -8
  586. package/lib/block_handler/DefaultBlockResponseGenerator.d.ts +0 -14
  587. package/lib/block_handler/DefaultBlockResponseGenerator.js +0 -49
  588. package/lib/block_handler/IBlockResponseGenerator.d.ts +0 -14
  589. package/lib/block_handler/IBlockResponseGenerator.js +0 -2
  590. package/lib/block_handler/captcha/CaptchaBlockResponseGenerator.d.ts +0 -14
  591. package/lib/block_handler/captcha/CaptchaBlockResponseGenerator.js +0 -30
  592. package/lib/block_handler/captcha/HtmlCaptchaResponseGenerator.d.ts +0 -10
  593. package/lib/block_handler/captcha/HtmlCaptchaResponseGenerator.js +0 -29
  594. package/lib/block_handler/captcha/JsonCaptchaResponseGenerator.d.ts +0 -10
  595. package/lib/block_handler/captcha/JsonCaptchaResponseGenerator.js +0 -47
  596. package/lib/block_handler/captcha/MobileCaptchaResponseGenerator.d.ts +0 -12
  597. package/lib/block_handler/captcha/MobileCaptchaResponseGenerator.js +0 -41
  598. package/lib/block_handler/index.d.ts +0 -13
  599. package/lib/block_handler/index.js +0 -21
  600. package/lib/block_handler/model/BlockData.js +0 -2
  601. package/lib/block_handler/model/JsonBlockPayload.js +0 -2
  602. package/lib/block_handler/model/MobileBlockPayload.js +0 -2
  603. package/lib/block_handler/templates/captcha_template.js +0 -4
  604. package/lib/block_handler/templates/rate_limit_template.js +0 -4
  605. package/lib/block_handler/utils.d.ts +0 -5
  606. package/lib/block_handler/utils.js +0 -48
  607. package/lib/context/ContextBase.d.ts +0 -56
  608. package/lib/context/ContextBase.js +0 -139
  609. package/lib/context/DefaultTokenV2Context.d.ts +0 -13
  610. package/lib/context/DefaultTokenV2Context.js +0 -35
  611. package/lib/context/DefaultTokenV3Context.d.ts +0 -13
  612. package/lib/context/DefaultTokenV3Context.js +0 -35
  613. package/lib/context/IContext.d.ts +0 -263
  614. package/lib/context/IContext.js +0 -2
  615. package/lib/filter/DefaultFilter.d.ts +0 -16
  616. package/lib/filter/DefaultFilter.js +0 -59
  617. package/lib/first_party/DefaultFirstParty.d.ts +0 -22
  618. package/lib/first_party/DefaultFirstParty.js +0 -227
  619. package/lib/first_party/constants.js +0 -37
  620. package/lib/first_party/utils.d.ts +0 -9
  621. package/lib/first_party/utils.js +0 -29
  622. package/lib/http/interfaces/ReadOnlyHeaders.d.ts +0 -4
  623. package/lib/http/interfaces/ReadOnlyHeaders.js +0 -19
  624. package/lib/risk_api/PostRiskApiClient.d.ts +0 -43
  625. package/lib/risk_api/PostRiskApiClient.js +0 -261
  626. package/lib/risk_api/S2SCallReason.js +0 -16
  627. package/lib/risk_api/S2SErrorHandler.d.ts +0 -9
  628. package/lib/risk_api/S2SErrorHandler.js +0 -121
  629. package/lib/risk_api/model/RiskResponseV2.d.ts +0 -12
  630. package/lib/risk_api/model/RiskResponseV2.js +0 -2
  631. package/lib/risk_api/model/RiskResponseV3.d.ts +0 -12
  632. package/lib/risk_api/model/RiskResponseV3.js +0 -2
  633. package/lib/risk_api/risk_response_handler/IRiskResponseHandler.d.ts +0 -5
  634. package/lib/risk_api/risk_response_handler/IRiskResponseHandler.js +0 -2
  635. package/lib/risk_api/risk_response_handler/RiskResponseHandlerBase.d.ts +0 -16
  636. package/lib/risk_api/risk_response_handler/RiskResponseHandlerBase.js +0 -73
  637. package/lib/risk_api/risk_response_handler/RiskResponseV2Handler.d.ts +0 -10
  638. package/lib/risk_api/risk_response_handler/RiskResponseV2Handler.js +0 -47
  639. package/lib/risk_api/risk_response_handler/RiskResponseV3Handler.d.ts +0 -10
  640. package/lib/risk_api/risk_response_handler/RiskResponseV3Handler.js +0 -47
  641. package/lib/risk_token/MobileErrorHandler.d.ts +0 -9
  642. package/lib/risk_token/MobileErrorHandler.js +0 -100
  643. package/lib/risk_token/RiskTokenScoreRetriever.d.ts +0 -14
  644. package/lib/risk_token/RiskTokenScoreRetriever.js +0 -148
  645. package/lib/risk_token/TokenVerificationResult.js +0 -10
  646. package/lib/risk_token/token/BotDefenderTokenBase.d.ts +0 -29
  647. package/lib/risk_token/token/BotDefenderTokenBase.js +0 -95
  648. package/lib/risk_token/token/IBotDefenderToken.js +0 -2
  649. package/lib/risk_token/token/v2/BotDefenderTokenV2Payload.js +0 -2
  650. package/lib/risk_token/token/v2/DefaultBotDefenderTokenV2.d.ts +0 -26
  651. package/lib/risk_token/token/v2/DefaultBotDefenderTokenV2.js +0 -206
  652. package/lib/risk_token/token/v3/BotDefenderTokenV3Payload.d.ts +0 -9
  653. package/lib/risk_token/token/v3/BotDefenderTokenV3Payload.js +0 -2
  654. package/lib/risk_token/token/v3/DefaultBotDefenderTokenV3.d.ts +0 -29
  655. package/lib/risk_token/token/v3/DefaultBotDefenderTokenV3.js +0 -231
  656. package/lib/utils/IScoreRetriever.d.ts +0 -14
  657. package/lib/utils/IScoreRetriever.js +0 -2
  658. package/lib/utils/PassReason.js +0 -10
  659. package/lib/utils/cookie_parser/DefaultCookieParser.js +0 -13
  660. package/lib/utils/hash/CryptoHmacUtils.js +0 -25
  661. package/lib/utils/hash/CryptoJSHmacUtils.js +0 -19
  662. package/lib/utils/uuid_generator/DefaultUuidGenerator.d.ts +0 -4
  663. package/lib/utils/uuid_generator/DefaultUuidGenerator.js +0 -13
  664. package/lib/utils/uuid_generator/IUuidGenerator.d.ts +0 -3
  665. package/lib/utils/uuid_generator/IUuidGenerator.js +0 -2
  666. package/lib/utils/uuid_generator/index.d.ts +0 -2
  667. package/lib/utils/uuid_generator/index.js +0 -5
  668. /package/lib/{block_handler → products/bot_defender/block}/model/JsonBlockPayload.d.ts +0 -0
  669. /package/lib/{block_handler → products/bot_defender/block}/model/MobileBlockPayload.d.ts +0 -0
  670. /package/lib/{block_handler → products/bot_defender/block}/templates/captcha_template.d.ts +0 -0
  671. /package/lib/{block_handler → products/bot_defender/block}/templates/rate_limit_template.d.ts +0 -0
  672. /package/lib/risk_api/{S2SErrorReason.d.ts → model/S2SErrorReason.d.ts} +0 -0
@@ -0,0 +1,46 @@
1
+ import { IConfiguration } from '../config';
2
+ import { BlockAction } from '../blocker';
3
+ import { CustomParameters } from '../custom_parameters';
4
+ import { PXDE } from '../pxde';
5
+ import { PXHD } from '../pxhd';
6
+ import { TokenOrigin } from '../risk_token';
7
+ import { IIncomingRequest, IOutgoingResponse, ReadonlyHeaders } from '../http';
8
+ import { ICookieParser, IRequestIdGenerator, VidSource } from '../utils';
9
+ import { IContext, RequestData, RiskApiData, ServerData, TlsData, TokenData } from './interfaces';
10
+ import { ProductData, ProductName } from '../products';
11
+ import { Action } from '../action';
12
+ export declare type DefaultContextOptions = {
13
+ cookieParser?: ICookieParser;
14
+ requestIdGenerator: IRequestIdGenerator;
15
+ };
16
+ export declare class DefaultContext<Req, Res> implements IContext<Req, Res> {
17
+ readonly requestId: string;
18
+ readonly tokenOrigin: TokenOrigin;
19
+ readonly requestData: RequestData<Req>;
20
+ readonly tokenData: TokenData<Req, Res>;
21
+ readonly riskApiData: RiskApiData;
22
+ readonly tlsData: TlsData;
23
+ readonly serverData: ServerData;
24
+ readonly productData: ProductData;
25
+ uuid: string;
26
+ vid?: string;
27
+ vidSource?: VidSource;
28
+ action: Action;
29
+ reasons?: Partial<Record<ProductName, string>>;
30
+ score?: number;
31
+ blockAction?: BlockAction;
32
+ pxhd?: PXHD;
33
+ pxde?: PXDE;
34
+ pxdeVerified?: boolean;
35
+ customParameters?: CustomParameters;
36
+ response?: IOutgoingResponse<Res>;
37
+ protected readonly config: IConfiguration<Req, Res>;
38
+ constructor(config: IConfiguration<Req, Res>, request: IIncomingRequest<Req>, options: DefaultContextOptions);
39
+ get isMobile(): boolean;
40
+ protected createRequestData(config: IConfiguration<Req, Res>, request: IIncomingRequest<Req>, cookieParser?: ICookieParser): RequestData<Req>;
41
+ protected static getCookies(cookieParser: ICookieParser, ...cookieHeaderValues: string[]): Record<string, string>;
42
+ protected extractUserAgentFromHeader(config: IConfiguration<Req, Res>, headers: ReadonlyHeaders): string;
43
+ protected extractIpFromHeader(config: IConfiguration<Req, Res>, headers: ReadonlyHeaders): string;
44
+ protected getTokenOrigin(request: IIncomingRequest<Req>): TokenOrigin;
45
+ protected setCookiesOnContext(): void;
46
+ }
@@ -0,0 +1,82 @@
1
+ import { BlockAction } from '../blocker';
2
+ import { PXHDSource } from '../pxhd';
3
+ import { TokenOrigin, TokenParseResult } from '../risk_token';
4
+ import { RiskApiCallResult } from '../risk_api';
5
+ import { COOKIE_HEADER_NAME, toReadonlyHeaders, USER_AGENT_HEADER_NAME, } from '../http';
6
+ import { StringSplitCookieParser, getDecodedUrl, PXHD_COOKIE_NAME, PXVID_COOKIE_NAME, X_PX_AUTHORIZATION_HEADER_NAME, } from '../utils';
7
+ export class DefaultContext {
8
+ constructor(config, request, options) {
9
+ this.config = config;
10
+ this.tokenData = {
11
+ tokenParseResult: TokenParseResult.NONE,
12
+ };
13
+ this.riskApiData = {
14
+ riskApiCallResult: RiskApiCallResult.NONE,
15
+ };
16
+ this.tlsData = {};
17
+ this.serverData = {};
18
+ this.productData = {};
19
+ this.requestId = options.requestIdGenerator.generateRequestId();
20
+ this.blockAction = BlockAction.CAPTCHA;
21
+ this.pxdeVerified = false;
22
+ this.requestData = this.createRequestData(config, request, options.cookieParser);
23
+ this.tokenOrigin = this.getTokenOrigin(request);
24
+ if (!this.isMobile) {
25
+ this.setCookiesOnContext();
26
+ }
27
+ }
28
+ get isMobile() {
29
+ return this.tokenOrigin === TokenOrigin.HEADER;
30
+ }
31
+ createRequestData(config, request, cookieParser = new StringSplitCookieParser()) {
32
+ const url = getDecodedUrl(request.url);
33
+ const method = request.method;
34
+ const headers = request.headers;
35
+ const cookies = DefaultContext.getCookies(cookieParser, request.headers.get(COOKIE_HEADER_NAME), request.headers.get(config.customCookieHeader));
36
+ const requestCookieNames = Object.keys(cookies);
37
+ const readOnlyHeaders = toReadonlyHeaders(headers);
38
+ const userAgent = this.extractUserAgentFromHeader(config, readOnlyHeaders);
39
+ const ip = this.extractIpFromHeader(config, readOnlyHeaders) || request.clientIP;
40
+ return { url, method, headers: readOnlyHeaders, cookies, ip, userAgent, requestCookieNames, request };
41
+ }
42
+ static getCookies(cookieParser, ...cookieHeaderValues) {
43
+ const cookies = {};
44
+ cookieHeaderValues.forEach((value) => {
45
+ Object.assign(cookies, value ? cookieParser.parseCookies(value) : null);
46
+ });
47
+ return cookies;
48
+ }
49
+ extractUserAgentFromHeader(config, headers) {
50
+ var _a;
51
+ let userAgent = ((_a = headers[USER_AGENT_HEADER_NAME]) === null || _a === void 0 ? void 0 : _a[0]) || '';
52
+ if (userAgent.length > config.userAgentMaxLength) {
53
+ userAgent = userAgent.substring(0, config.userAgentMaxLength);
54
+ }
55
+ return userAgent;
56
+ }
57
+ extractIpFromHeader(config, headers) {
58
+ let ip;
59
+ config.ipHeaders.some((ipHeader) => {
60
+ var _a;
61
+ const headerValue = (_a = headers[ipHeader]) === null || _a === void 0 ? void 0 : _a[0];
62
+ if (headerValue) {
63
+ ip = headerValue;
64
+ return true;
65
+ }
66
+ });
67
+ return ip;
68
+ }
69
+ getTokenOrigin(request) {
70
+ return request.headers.get(X_PX_AUTHORIZATION_HEADER_NAME) ? TokenOrigin.HEADER : TokenOrigin.COOKIE;
71
+ }
72
+ setCookiesOnContext() {
73
+ this.vid = this.requestData.cookies[PXVID_COOKIE_NAME] || '';
74
+ const pxhdCookie = this.requestData.cookies[PXHD_COOKIE_NAME] || '';
75
+ if (pxhdCookie) {
76
+ this.pxhd = {
77
+ value: pxhdCookie,
78
+ source: PXHDSource.COOKIE,
79
+ };
80
+ }
81
+ }
82
+ }
@@ -1,4 +1,2 @@
1
- export * from './IContext';
2
- export * from './ContextBase';
3
- export * from './DefaultTokenV2Context';
4
- export * from './DefaultTokenV3Context';
1
+ export * from './interfaces';
2
+ export * from './DefaultContext';
@@ -1,20 +1,2 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./IContext"), exports);
18
- __exportStar(require("./ContextBase"), exports);
19
- __exportStar(require("./DefaultTokenV2Context"), exports);
20
- __exportStar(require("./DefaultTokenV3Context"), exports);
1
+ export * from './interfaces';
2
+ export * from './DefaultContext';
@@ -0,0 +1,111 @@
1
+ import { VidSource } from '../../utils';
2
+ import { BlockAction } from '../../blocker';
3
+ import { CustomParameters } from '../../custom_parameters';
4
+ import { PXDE } from '../../pxde';
5
+ import { TokenOrigin } from '../../risk_token';
6
+ import { RequestData } from './RequestData';
7
+ import { RiskApiData } from './RiskApiData';
8
+ import { TlsData } from './TlsData';
9
+ import { ServerData } from './ServerData';
10
+ import { TokenData } from './TokenData';
11
+ import { ProductData, ProductName } from '../../products';
12
+ import { Action } from '../../action';
13
+ import { IOutgoingResponse } from '../../http';
14
+ import { GraphQLData } from '../../graphql';
15
+ import { PXHD } from '../../pxhd';
16
+ export interface IContext<Req, Res> {
17
+ /**
18
+ * A UUID generated in the enforcer unique to each HTTP request.
19
+ */
20
+ readonly requestId: string;
21
+ /**
22
+ * Whether the request is from a mobile device.
23
+ */
24
+ readonly isMobile: boolean;
25
+ /**
26
+ * An object containing details about the original HTTP request.
27
+ */
28
+ readonly requestData: RequestData<Req>;
29
+ /**
30
+ * An object containing details about the token.
31
+ */
32
+ readonly tokenData: TokenData<Req, Res>;
33
+ /**
34
+ * An object containing details about the risk API data.
35
+ */
36
+ readonly riskApiData: RiskApiData;
37
+ /**
38
+ * An object containing details about the TLS metadata of the HTTP request.
39
+ */
40
+ readonly tlsData: TlsData;
41
+ /**
42
+ * An object containing details about the server on which the enforcer is running.
43
+ */
44
+ readonly serverData: ServerData;
45
+ /**
46
+ * An object containing data related to specific products.
47
+ */
48
+ readonly productData: ProductData;
49
+ /**
50
+ * The client UUID.
51
+ */
52
+ uuid: string;
53
+ /**
54
+ * The visitor ID, unique to the end-user.
55
+ */
56
+ vid?: string;
57
+ /**
58
+ * A string representing where the visitor ID was obtained.
59
+ */
60
+ vidSource?: VidSource;
61
+ /**
62
+ * The origin of the risk token, indicating whether the request originates from
63
+ * a web browser ('cookie') or from the mobile SDK ('header').
64
+ */
65
+ tokenOrigin: TokenOrigin;
66
+ /**
67
+ * The risk score retrieved from either the risk cookie or risk API request. This should be a value
68
+ * between 0 and 100 (inclusive), with 100 representing a bot.
69
+ */
70
+ score?: number;
71
+ /**
72
+ * The action to be taken by the enforcer.
73
+ */
74
+ action: Action;
75
+ /**
76
+ * The products that suggested the decided action and their corresponding reasons for doing so.
77
+ */
78
+ reasons?: Partial<Record<ProductName, string>>;
79
+ /**
80
+ * The type of block page to present in case of a block.
81
+ */
82
+ blockAction?: BlockAction;
83
+ /**
84
+ * The PXHD (PerimeterX Hashed Data) cookie value, if it exists on the request.
85
+ */
86
+ pxhd?: PXHD;
87
+ /**
88
+ * The PXDE (PerimeterX Data Enrichment) object, if it was parsed from
89
+ * the PXDE cookie or received on the risk response.
90
+ */
91
+ pxde?: PXDE;
92
+ /**
93
+ * Whether the HMAC on the PXDE cookie has been validated. If the PXDE object
94
+ * was received on the risk response, this value will be true.
95
+ */
96
+ pxdeVerified?: boolean;
97
+ /**
98
+ * An object with 10 custom parameters that the customer can set and define. These
99
+ * custom parameters will be added to the activities sent to the collector.
100
+ */
101
+ customParameters?: CustomParameters;
102
+ /**
103
+ * An array of objects with information about the different GraphQL operations
104
+ * parsed from the request.
105
+ */
106
+ graphqlData?: GraphQLData[];
107
+ /**
108
+ * The response from the origin server.
109
+ */
110
+ response?: IOutgoingResponse<Res>;
111
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,23 @@
1
+ import { IToken, MobileError, TokenParseResult } from '../../risk_token';
2
+ export declare type MobileData<Req, Res> = {
3
+ /**
4
+ * The mobile error sent on the X-PX-Authorization header for mobile requests.
5
+ */
6
+ mobileError?: MobileError;
7
+ /**
8
+ * An interface representing the original token sent on the X-PX-Original-Token header for mobile requests.
9
+ */
10
+ originalToken?: IToken<Req, Res>;
11
+ /**
12
+ * The bypass reason from the X-PX-Bypass-Reason header for mobile requests.
13
+ */
14
+ bypassReason?: string;
15
+ /**
16
+ * The result of parsing the original token.
17
+ */
18
+ originalTokenParseResult?: TokenParseResult;
19
+ /**
20
+ * The JSON string of the original token if one was sent on the mobile request.
21
+ */
22
+ decodedOriginalToken?: string;
23
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,3 @@
1
+ import { DeepReadonly } from 'ts-essentials';
2
+ import { IContext } from './IContext';
3
+ export declare type ReadonlyContext<Req, Res> = DeepReadonly<IContext<Req, Res>>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,41 @@
1
+ import { HttpMethod, IIncomingRequest, IURL, ReadonlyHeaders } from '../../http';
2
+ export declare type RequestData<Req> = {
3
+ /**
4
+ * The request URL.
5
+ */
6
+ url: IURL;
7
+ /**
8
+ * The request method, capitalized.
9
+ */
10
+ method: HttpMethod;
11
+ /**
12
+ * An object representing the request headers. The keys are the header names (all lowercase) and the values
13
+ * are arrays of strings, with each string representing one value associated with the header name.
14
+ */
15
+ headers: ReadonlyHeaders;
16
+ /**
17
+ * An object representing the request cookies. The keys are the cookie
18
+ * names and the values are the cookie values.
19
+ */
20
+ cookies: Record<string, string>;
21
+ /**
22
+ * An array of the cookie names present on the request.
23
+ */
24
+ requestCookieNames: string[];
25
+ /**
26
+ * The user agent header on the request.
27
+ */
28
+ userAgent: string;
29
+ /**
30
+ * The IP of the request.
31
+ */
32
+ ip: string;
33
+ /**
34
+ * An interface representing the original HTTP request.
35
+ */
36
+ request: IIncomingRequest<Req>;
37
+ /**
38
+ * The HTTP version used for the request (e.g., 0.9, 1.0, 1.1, 2.0).
39
+ */
40
+ httpVersion?: string;
41
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,27 @@
1
+ import { IRiskResponse, S2SErrorReason, RiskApiCallResult } from '../../risk_api';
2
+ export declare type RiskApiData = {
3
+ /**
4
+ * The result of the risk API call.
5
+ */
6
+ riskApiCallResult: RiskApiCallResult;
7
+ /**
8
+ * An interface representing the risk API response.
9
+ */
10
+ riskResponse?: IRiskResponse;
11
+ /**
12
+ * The risk API round trip time in milliseconds.
13
+ */
14
+ riskRtt?: number;
15
+ /**
16
+ * The reason for the error during the risk API call if an error occurred.
17
+ */
18
+ errorReason?: S2SErrorReason;
19
+ /**
20
+ * The HTTP response status that was received for the risk API call if an error occurred.
21
+ */
22
+ errorHttpStatus?: number;
23
+ /**
24
+ * An error message that contains more details about the risk API error if an error occurred.
25
+ */
26
+ errorMessage?: string;
27
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,18 @@
1
+ export declare type ServerData = {
2
+ /**
3
+ * The operating system platform.
4
+ */
5
+ osName?: string;
6
+ /**
7
+ * The server region the request hit.
8
+ */
9
+ region?: string;
10
+ /**
11
+ * The host name of the operating system.
12
+ */
13
+ nodeName?: string;
14
+ /**
15
+ * The name or code associated with the server PoP/datacenter.
16
+ */
17
+ datacenter?: string;
18
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,30 @@
1
+ export declare type TlsData = {
2
+ /**
3
+ * The TLS version used for the HTTPS request (e.g., 1.2, 1.3).
4
+ */
5
+ tlsProtocol?: string;
6
+ /**
7
+ * The Server Name Indication (SNI) the client sent in the TLS Client Hello packet of the HTTPS request.
8
+ */
9
+ tlsServer?: string;
10
+ /**
11
+ * The name of the TLS cipher used to encrypt the HTTPS request.
12
+ */
13
+ tlsCipher?: string;
14
+ /**
15
+ * The hash used to encrypt the HTTPS request.
16
+ */
17
+ tlsCiphersSha?: string;
18
+ /**
19
+ * The hash of the TLS extension identifiers sent from the client as part of the TLS handshake
20
+ */
21
+ tlsExtensionSha?: string;
22
+ /**
23
+ * The client's preferred TLS ciphers for the HTTPS request.
24
+ */
25
+ tlsPreferredCiphers?: string;
26
+ /**
27
+ * The JA3 fingerprint computed from the TLS Client Hello packet of th HTTPS request.
28
+ */
29
+ tlsJa3Fingerprint?: string;
30
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,16 @@
1
+ import { IToken, TokenParseResult } from '../../risk_token';
2
+ import { MobileData } from './MobileData';
3
+ export declare type TokenData<Req, Res> = {
4
+ /**
5
+ * The result of token parsing.
6
+ */
7
+ tokenParseResult: TokenParseResult;
8
+ /**
9
+ * An interface representing the risk token.
10
+ */
11
+ token?: IToken<Req, Res>;
12
+ /**
13
+ * An object containing details about the mobile data if the request was made from a mobile device.
14
+ */
15
+ mobileData?: MobileData<Req, Res>;
16
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ export * from './RequestData';
2
+ export * from './RiskApiData';
3
+ export * from './MobileData';
4
+ export * from './TokenData';
5
+ export * from './TlsData';
6
+ export * from './ServerData';
7
+ export * from './IContext';
8
+ export * from './ReadonlyContext';
@@ -0,0 +1,8 @@
1
+ export * from './RequestData';
2
+ export * from './RiskApiData';
3
+ export * from './MobileData';
4
+ export * from './TokenData';
5
+ export * from './TlsData';
6
+ export * from './ServerData';
7
+ export * from './IContext';
8
+ export * from './ReadonlyContext';
@@ -0,0 +1,2 @@
1
+ import { ReadonlyHeaders } from '../http';
2
+ export declare type CustomBlockResponseHeadersHandler<Req> = (request: Req) => ReadonlyHeaders | Promise<ReadonlyHeaders>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,2 @@
1
+ import { IMinimalResponse } from '../http';
2
+ export declare type CustomPreflightHandler<Req> = (request: Req) => IMinimalResponse | Promise<IMinimalResponse>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,15 @@
1
+ import { ICors } from './ICors';
2
+ import { IConfiguration } from '../config';
3
+ import { ReadonlyContext } from '../context';
4
+ import { ReadonlyHeaders, IMinimalResponse } from '../http';
5
+ export declare class DefaultCors<Req, Res> implements ICors<Req, Res> {
6
+ private readonly customBlockResponseHeaders;
7
+ private readonly customPreflightHandler;
8
+ private readonly logger;
9
+ constructor(config: IConfiguration<Req, Res>);
10
+ isPreflightRequest(context: ReadonlyContext<Req, Res>): boolean;
11
+ runPreflightCustomHandler(context: ReadonlyContext<Req, Res>): Promise<IMinimalResponse>;
12
+ isCorsRequest(context: ReadonlyContext<Req, Res>): boolean;
13
+ getCorsBlockHeaders(context: ReadonlyContext<Req, Res>): Promise<ReadonlyHeaders>;
14
+ getDefaultCorsHeaders(context: ReadonlyContext<Req, Res>): ReadonlyHeaders;
15
+ }
@@ -0,0 +1,59 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ import { ACCESS_CONTROL_REQUEST_METHOD_HEADER, ORIGIN_HEADER } from './constants';
11
+ import { HttpMethod } from '../http';
12
+ export class DefaultCors {
13
+ constructor(config) {
14
+ this.customBlockResponseHeaders = config.corsCreateCustomBlockResponseHeaders;
15
+ this.customPreflightHandler = config.corsCustomPreflightHandler;
16
+ this.logger = config.logger;
17
+ }
18
+ isPreflightRequest(context) {
19
+ const { requestData } = context;
20
+ return !!(requestData.method.toUpperCase() === HttpMethod.OPTIONS &&
21
+ requestData.headers[ORIGIN_HEADER] &&
22
+ requestData.headers[ACCESS_CONTROL_REQUEST_METHOD_HEADER]);
23
+ }
24
+ runPreflightCustomHandler(context) {
25
+ return __awaiter(this, void 0, void 0, function* () {
26
+ if (this.customPreflightHandler && typeof this.customPreflightHandler === 'function') {
27
+ try {
28
+ return yield this.customPreflightHandler(context.requestData.request.getUnderlyingRequest());
29
+ }
30
+ catch (e) {
31
+ this.logger.debug(`Exception occurred while executing custom preflight handler: ${e}`);
32
+ }
33
+ }
34
+ return null;
35
+ });
36
+ }
37
+ isCorsRequest(context) {
38
+ return !!context.requestData.headers[ORIGIN_HEADER];
39
+ }
40
+ getCorsBlockHeaders(context) {
41
+ return __awaiter(this, void 0, void 0, function* () {
42
+ if (this.customBlockResponseHeaders && typeof this.customBlockResponseHeaders === 'function') {
43
+ try {
44
+ return yield this.customBlockResponseHeaders(context.requestData.request.getUnderlyingRequest());
45
+ }
46
+ catch (e) {
47
+ this.logger.debug(`Exception occurred in px_cors_create_custom_block_response_headers custom function: ${e}`);
48
+ }
49
+ }
50
+ return this.getDefaultCorsHeaders(context);
51
+ });
52
+ }
53
+ getDefaultCorsHeaders(context) {
54
+ return {
55
+ 'Access-Control-Allow-Origin': context.requestData.headers[ORIGIN_HEADER],
56
+ 'Access-Control-Allow-Credentials': ['true'],
57
+ };
58
+ }
59
+ }
@@ -0,0 +1,26 @@
1
+ import { ReadonlyContext } from '../context';
2
+ import { IMinimalResponse } from '../http';
3
+ import { ReadonlyHeaders } from '../http';
4
+ export interface ICors<Req, Res> {
5
+ /**
6
+ * @param context
7
+ * @returns boolean - Whether the request is preflight.
8
+ */
9
+ isPreflightRequest(context: ReadonlyContext<Req, Res>): boolean;
10
+ /**
11
+ * @param context- The request context.
12
+ * @returns IMinimalResponse- The response that return to client for preflight request.
13
+ */
14
+ runPreflightCustomHandler(context: ReadonlyContext<Req, Res>): Promise<IMinimalResponse> | null;
15
+ /**
16
+ * @param context- The request context.
17
+ * @returns boolean - Whether the request is CORS.
18
+ */
19
+ isCorsRequest(context: ReadonlyContext<Req, Res>): boolean;
20
+ /**
21
+ *
22
+ * @param context - The request context.
23
+ * @returns ReadOnlyHeaders - headers to be added to the block response.
24
+ */
25
+ getCorsBlockHeaders(context: ReadonlyContext<Req, Res>): Promise<ReadonlyHeaders>;
26
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,2 @@
1
+ export declare const ORIGIN_HEADER = "origin";
2
+ export declare const ACCESS_CONTROL_REQUEST_METHOD_HEADER = "access-control-request-method";
@@ -0,0 +1,2 @@
1
+ export const ORIGIN_HEADER = 'origin';
2
+ export const ACCESS_CONTROL_REQUEST_METHOD_HEADER = 'access-control-request-method';
@@ -0,0 +1,5 @@
1
+ export { ICors } from './ICors';
2
+ export { CustomPreflightHandler } from './CustomPreflightHandler';
3
+ export { CustomBlockResponseHeadersHandler } from './CustomBlockResponseHeadersHandler';
4
+ export { DefaultCors } from './DefaultCors';
5
+ export * from './constants';
@@ -0,0 +1,2 @@
1
+ export { DefaultCors } from './DefaultCors';
2
+ export * from './constants';
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
@@ -1,4 +1,3 @@
1
1
  import { ConfigurationParams } from '../config';
2
2
  import { CustomParameters } from './CustomParameters';
3
- import { IIncomingRequest } from '../http/interfaces/IIncomingRequest';
4
- export declare type CustomParametersFunction = (config: ConfigurationParams, httpRequest: IIncomingRequest) => CustomParameters | Promise<CustomParameters>;
3
+ export declare type CustomParametersFunction<Req, Res> = (config: ConfigurationParams<Req, Res>, request: Req) => CustomParameters | Promise<CustomParameters>;
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
@@ -1,7 +1,7 @@
1
1
  import { IConfiguration } from '../config';
2
- import { IContext } from '../context';
2
+ import { ReadonlyContext } from '../context';
3
3
  import { CustomParameters } from './CustomParameters';
4
4
  export declare namespace CustomParametersUtils {
5
- const handleCustomParameters: (config: IConfiguration, context: IContext) => Promise<void>;
5
+ const createCustomParameters: <Req, Res>(config: IConfiguration<Req, Res>, context: ReadonlyContext<Req, Res>) => Promise<CustomParameters | null>;
6
6
  const normalizeCustomParams: (customParameters: Record<string, any>) => CustomParameters;
7
7
  }