Update docs

hodgef · Jan 17, 2024 · cb7e578 · cb7e578
1 parent dfec6a6
commit cb7e578
Show file tree

Hide file tree

Showing 128 changed files with 148 additions and 142 deletions.
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/Apiker.html b/docs/classes/Apiker.html
diff --git a/docs/classes/ResponseParams.html b/docs/classes/ResponseParams.html
diff --git a/docs/functions/addLogEntry.html b/docs/functions/addLogEntry.html
diff --git a/docs/functions/addUniqueLogEntry.html b/docs/functions/addUniqueLogEntry.html
diff --git a/docs/functions/banEntity.html b/docs/functions/banEntity.html
diff --git a/docs/functions/bansEndpoint.html b/docs/functions/bansEndpoint.html
diff --git a/docs/functions/bansMiddleware.html b/docs/functions/bansMiddleware.html
diff --git a/docs/functions/checkUser.html b/docs/functions/checkUser.html
diff --git a/docs/functions/compare_bcrypt.html b/docs/functions/compare_bcrypt.html
diff --git a/docs/functions/createJWT.html b/docs/functions/createJWT.html
diff --git a/docs/functions/decodeString.html b/docs/functions/decodeString.html
diff --git a/docs/functions/deleteAllLogsInObject.html b/docs/functions/deleteAllLogsInObject.html
diff --git a/docs/functions/deleteAllObjectState.html b/docs/functions/deleteAllObjectState.html
diff --git a/docs/functions/deleteLogEntries.html b/docs/functions/deleteLogEntries.html
diff --git a/docs/functions/deleteObjectState.html b/docs/functions/deleteObjectState.html
diff --git a/docs/functions/deleteUserLogEntries.html b/docs/functions/deleteUserLogEntries.html
diff --git a/docs/functions/elapsedSinceRequestStart.html b/docs/functions/elapsedSinceRequestStart.html
diff --git a/docs/functions/encodeString.html b/docs/functions/encodeString.html
diff --git a/docs/functions/extractToken.html b/docs/functions/extractToken.html
diff --git a/docs/functions/firewallBanIP.html b/docs/functions/firewallBanIP.html
diff --git a/docs/functions/firewallMiddleware.html b/docs/functions/firewallMiddleware.html
diff --git a/docs/functions/firewallUnbanIP.html b/docs/functions/firewallUnbanIP.html
diff --git a/docs/functions/forgotUser.html b/docs/functions/forgotUser.html
diff --git a/docs/functions/forgotUserAction.html b/docs/functions/forgotUserAction.html
diff --git a/docs/functions/forgotUserReset.html b/docs/functions/forgotUserReset.html
diff --git a/docs/functions/forwardToMiddleware.html b/docs/functions/forwardToMiddleware.html
diff --git a/docs/functions/getAllLogEntries.html b/docs/functions/getAllLogEntries.html
diff --git a/docs/functions/getAuthRoutes.html b/docs/functions/getAuthRoutes.html
diff --git a/docs/functions/getBannedEntities.html b/docs/functions/getBannedEntities.html
diff --git a/docs/functions/getBannedEntries.html b/docs/functions/getBannedEntries.html
diff --git a/docs/functions/getClientId.html b/docs/functions/getClientId.html
diff --git a/docs/functions/getCurrentUser.html b/docs/functions/getCurrentUser.html
diff --git a/docs/functions/getCurrentUserGeodata.html b/docs/functions/getCurrentUserGeodata.html
diff --git a/docs/functions/getEnvObject.html b/docs/functions/getEnvObject.html
diff --git a/docs/functions/getFirewallBannedEntryId.html b/docs/functions/getFirewallBannedEntryId.html
diff --git a/docs/functions/getLogEntries.html b/docs/functions/getLogEntries.html
diff --git a/docs/functions/getLogParams.html b/docs/functions/getLogParams.html
diff --git a/docs/functions/getObjectState.html b/docs/functions/getObjectState.html
diff --git a/docs/functions/getRawIp.html b/docs/functions/getRawIp.html
diff --git a/docs/functions/getSignedIp.html b/docs/functions/getSignedIp.html
diff --git a/docs/functions/getStateMethods.html b/docs/functions/getStateMethods.html
diff --git a/docs/functions/getTokens.html b/docs/functions/getTokens.html
diff --git a/docs/functions/getUserGeodata.html b/docs/functions/getUserGeodata.html
diff --git a/docs/functions/getUserLogEntries.html b/docs/functions/getUserLogEntries.html
diff --git a/docs/functions/getUserLogPropertyName.html b/docs/functions/getUserLogPropertyName.html
diff --git a/docs/functions/handleEntryRequest.html b/docs/functions/handleEntryRequest.html
diff --git a/docs/functions/hash_bcrypt.html b/docs/functions/hash_bcrypt.html
diff --git a/docs/functions/isCurrentUserAdmin.html b/docs/functions/isCurrentUserAdmin.html
diff --git a/docs/functions/isEmail.html b/docs/functions/isEmail.html
diff --git a/docs/functions/isEntityBanned.html b/docs/functions/isEntityBanned.html
diff --git a/docs/functions/isRateLimitReached.html b/docs/functions/isRateLimitReached.html
diff --git a/docs/functions/isRequiredLength.html b/docs/functions/isRequiredLength.html
diff --git a/docs/functions/isUserAdmin.html b/docs/functions/isUserAdmin.html
diff --git a/docs/functions/listObjectState.html b/docs/functions/listObjectState.html
diff --git a/docs/functions/loginEndpoint.html b/docs/functions/loginEndpoint.html
diff --git a/docs/functions/loginUser.html b/docs/functions/loginUser.html
diff --git a/docs/functions/loginUserAction.html b/docs/functions/loginUserAction.html
diff --git a/docs/functions/measureTiming.html b/docs/functions/measureTiming.html
diff --git a/docs/functions/pageFooter.html b/docs/functions/pageFooter.html
diff --git a/docs/functions/pageHeader.html b/docs/functions/pageHeader.html
diff --git a/docs/functions/parseJWT.html b/docs/functions/parseJWT.html
diff --git a/docs/functions/parseObjectStateMapping.html b/docs/functions/parseObjectStateMapping.html
diff --git a/docs/functions/putObjectState.html b/docs/functions/putObjectState.html
diff --git a/docs/functions/randomHash.html b/docs/functions/randomHash.html
diff --git a/docs/functions/randomHash_SHA1.html b/docs/functions/randomHash_SHA1.html
diff --git a/docs/functions/rateLimitRequest.html b/docs/functions/rateLimitRequest.html
diff --git a/docs/functions/readRequestBody.html b/docs/functions/readRequestBody.html
diff --git a/docs/functions/refreshUser.html b/docs/functions/refreshUser.html
diff --git a/docs/functions/registerUser.html b/docs/functions/registerUser.html
diff --git a/docs/functions/registerUserAction.html b/docs/functions/registerUserAction.html
diff --git a/docs/functions/res.html b/docs/functions/res.html
diff --git a/docs/functions/resRaw.html b/docs/functions/resRaw.html
diff --git a/docs/functions/res_200.html b/docs/functions/res_200.html
diff --git a/docs/functions/res_204.html b/docs/functions/res_204.html
diff --git a/docs/functions/res_400.html b/docs/functions/res_400.html
diff --git a/docs/functions/res_401.html b/docs/functions/res_401.html
diff --git a/docs/functions/res_404.html b/docs/functions/res_404.html
diff --git a/docs/functions/res_429.html b/docs/functions/res_429.html
diff --git a/docs/functions/res_500.html b/docs/functions/res_500.html
diff --git a/docs/functions/searchBansEndpoint.html b/docs/functions/searchBansEndpoint.html
diff --git a/docs/functions/sendEmail.html b/docs/functions/sendEmail.html
diff --git a/docs/functions/sendEmailEndpoint.html b/docs/functions/sendEmailEndpoint.html
diff --git a/docs/functions/sign.html b/docs/functions/sign.html
diff --git a/docs/functions/sign_sha1.html b/docs/functions/sign_sha1.html
diff --git a/docs/functions/sign_sha256.html b/docs/functions/sign_sha256.html
diff --git a/docs/functions/unbanEntity.html b/docs/functions/unbanEntity.html
diff --git a/docs/functions/updateUserEndpoint.html b/docs/functions/updateUserEndpoint.html
diff --git a/docs/functions/wrapPage.html b/docs/functions/wrapPage.html
diff --git a/docs/functions/wrapReactPage.html b/docs/functions/wrapReactPage.html
diff --git a/docs/interfaces/Controllers.html b/docs/interfaces/Controllers.html
diff --git a/docs/interfaces/EmailActor.html b/docs/interfaces/EmailActor.html
diff --git a/docs/interfaces/EmailOptions.html b/docs/interfaces/EmailOptions.html
diff --git a/docs/interfaces/Firewall.html b/docs/interfaces/Firewall.html
diff --git a/docs/interfaces/ListRequestObject.html b/docs/interfaces/ListRequestObject.html
diff --git a/docs/interfaces/LogObject.html b/docs/interfaces/LogObject.html
diff --git a/docs/interfaces/Options.html b/docs/interfaces/Options.html
diff --git a/docs/interfaces/PutRequestObject.html b/docs/interfaces/PutRequestObject.html
diff --git a/docs/interfaces/RequestParams.html b/docs/interfaces/RequestParams.html
diff --git a/docs/interfaces/RouteObject.html b/docs/interfaces/RouteObject.html
diff --git a/docs/interfaces/Routes.html b/docs/interfaces/Routes.html
diff --git a/docs/interfaces/StateMethods.html b/docs/interfaces/StateMethods.html
diff --git a/docs/interfaces/User.html b/docs/interfaces/User.html
diff --git a/docs/modules.html b/docs/modules.html
@@ -19,7 +19,8 @@
 <a href="types/ObjectStateMapping.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Object<wbr/>State<wbr/>Mapping</span></a>
 <a href="types/StateFn.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>State<wbr/>Fn</span></a>
 <a href="types/Timings.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Timings</span></a>
-</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="variables/EMAIL_API_ENDPOINT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>EMAIL_<wbr/>API_<wbr/>ENDPOINT</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="variables/BANS_PREFIX.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>BANS_<wbr/>PREFIX</span></a>
+<a href="variables/EMAIL_API_ENDPOINT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>EMAIL_<wbr/>API_<wbr/>ENDPOINT</span></a>
 <a href="variables/FIREWALL_ENDPOINT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>FIREWALL_<wbr/>ENDPOINT</span></a>
 <a href="variables/FIREWALL_RATELIMIT_PREFIX.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>FIREWALL_<wbr/>RATELIMIT_<wbr/>PREFIX</span></a>
 <a href="variables/FIREWALL_REQUESTS_MINUTE.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>FIREWALL_<wbr/>REQUESTS_<wbr/>MINUTE</span></a>
@@ -38,6 +39,7 @@
 <a href="functions/addUniqueLogEntry.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>add<wbr/>Unique<wbr/>Log<wbr/>Entry</span></a>
 <a href="functions/banEntity.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>ban<wbr/>Entity</span></a>
 <a href="functions/bansEndpoint.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>bans<wbr/>Endpoint</span></a>
+<a href="functions/bansMiddleware.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>bans<wbr/>Middleware</span></a>
 <a href="functions/checkUser.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>check<wbr/>User</span></a>
 <a href="functions/compare_bcrypt.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>compare_<wbr/>bcrypt</span></a>
 <a href="functions/createJWT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>createJWT</span></a>

diff --git a/docs/types/Controller.html b/docs/types/Controller.html
diff --git a/docs/types/Handler.html b/docs/types/Handler.html
diff --git a/docs/types/Middleware.html b/docs/types/Middleware.html
diff --git a/docs/types/ObjectStateMapping.html b/docs/types/ObjectStateMapping.html
diff --git a/docs/types/StateFn.html b/docs/types/StateFn.html
diff --git a/docs/types/Timings.html b/docs/types/Timings.html
diff --git a/docs/variables/BANS_PREFIX.html b/docs/variables/BANS_PREFIX.html
diff --git a/docs/variables/EMAIL_API_ENDPOINT.html b/docs/variables/EMAIL_API_ENDPOINT.html
diff --git a/docs/variables/FIREWALL_ENDPOINT.html b/docs/variables/FIREWALL_ENDPOINT.html
diff --git a/docs/variables/FIREWALL_RATELIMIT_PREFIX.html b/docs/variables/FIREWALL_RATELIMIT_PREFIX.html
diff --git a/docs/variables/FIREWALL_REQUESTS_MINUTE.html b/docs/variables/FIREWALL_REQUESTS_MINUTE.html
diff --git a/docs/variables/MAX_STR_LEN.html b/docs/variables/MAX_STR_LEN.html
diff --git a/docs/variables/MIN_STR_LEN.html b/docs/variables/MIN_STR_LEN.html
diff --git a/docs/variables/OBMT.html b/docs/variables/OBMT.html
diff --git a/docs/variables/OBN.html b/docs/variables/OBN.html
diff --git a/docs/variables/RESPONSE_HEADERS_DEFAULT.html b/docs/variables/RESPONSE_HEADERS_DEFAULT.html
diff --git a/docs/variables/RESPONSE_MESSAGES.html b/docs/variables/RESPONSE_MESSAGES.html
diff --git a/docs/variables/apiker-1.html b/docs/variables/apiker-1.html
diff --git a/docs/variables/forgotPasswordTemplate.html b/docs/variables/forgotPasswordTemplate.html
diff --git a/docs/variables/newPasswordTemplate.html b/docs/variables/newPasswordTemplate.html
diff --git a/docs/variables/verifyAccountSuccessTemplate.html b/docs/variables/verifyAccountSuccessTemplate.html
diff --git a/docs/variables/verifyAccountTemplate.html b/docs/variables/verifyAccountTemplate.html
diff --git a/src/components/Bans/index.ts b/src/components/Bans/index.ts
@@ -1 +1,3 @@
-export * from "./Bans";
+export * from "./Bans";
+export * from "./middleware";
+export * from "./constants";