diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 3d065f6..71e3491 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -13,8 +13,10 @@ --dark-hl-5: #9CDCFE; --light-hl-6: #795E26; --dark-hl-6: #DCDCAA; - --light-hl-7: #AF00DB; - --dark-hl-7: #C586C0; + --light-hl-7: #0070C1; + --dark-hl-7: #4FC1FF; + --light-hl-8: #AF00DB; + --dark-hl-8: #C586C0; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -28,6 +30,7 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); --code-background: var(--light-code-background); } } @@ -40,6 +43,7 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); --code-background: var(--dark-code-background); } } @@ -52,6 +56,7 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); --code-background: var(--light-code-background); } @@ -64,6 +69,7 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); --code-background: var(--dark-code-background); } @@ -75,4 +81,5 @@ .hl-5 { color: var(--hl-5); } .hl-6 { color: var(--hl-6); } .hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } pre, code { background: var(--code-background); } diff --git a/docs/assets/search.js b/docs/assets/search.js index e422ba1..30a83ee 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"auth\",\"url\":\"functions/auth.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimCheck\",\"url\":\"functions/claimCheck.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimEquals\",\"url\":\"functions/claimEquals.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimIncludes\",\"url\":\"functions/claimIncludes.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"requiredScopes\",\"url\":\"functions/requiredScopes.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"scopeIncludesAny\",\"url\":\"functions/scopeIncludesAny.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"AuthOptions\",\"url\":\"interfaces/AuthOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"issuerBaseURL\",\"url\":\"interfaces/AuthOptions.html#issuerBaseURL\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"interfaces/AuthOptions.html#audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"issuer\",\"url\":\"interfaces/AuthOptions.html#issuer\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"jwksUri\",\"url\":\"interfaces/AuthOptions.html#jwksUri\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"agent\",\"url\":\"interfaces/AuthOptions.html#agent\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"cooldownDuration\",\"url\":\"interfaces/AuthOptions.html#cooldownDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"timeoutDuration\",\"url\":\"interfaces/AuthOptions.html#timeoutDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"interfaces/AuthOptions.html#validators\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"clockTolerance\",\"url\":\"interfaces/AuthOptions.html#clockTolerance\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"maxTokenAge\",\"url\":\"interfaces/AuthOptions.html#maxTokenAge\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"strict\",\"url\":\"interfaces/AuthOptions.html#strict\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"secret\",\"url\":\"interfaces/AuthOptions.html#secret\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"tokenSigningAlg\",\"url\":\"interfaces/AuthOptions.html#tokenSigningAlg\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":256,\"name\":\"AuthResult\",\"url\":\"interfaces/AuthResult.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"header\",\"url\":\"interfaces/AuthResult.html#header\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthResult\"},{\"kind\":1024,\"name\":\"payload\",\"url\":\"interfaces/AuthResult.html#payload\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthResult\"},{\"kind\":1024,\"name\":\"token\",\"url\":\"interfaces/AuthResult.html#token\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthResult\"},{\"kind\":4194304,\"name\":\"JSONPrimitive\",\"url\":\"types/JSONPrimitive.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"UnauthorizedError\",\"url\":\"classes/UnauthorizedError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/UnauthorizedError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/UnauthorizedError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/UnauthorizedError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/UnauthorizedError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/UnauthorizedError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"UnauthorizedError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/UnauthorizedError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"UnauthorizedError.headers.__type\"},{\"kind\":128,\"name\":\"InvalidRequestError\",\"url\":\"classes/InvalidRequestError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InvalidRequestError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/InvalidRequestError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/InvalidRequestError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/InvalidRequestError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/InvalidRequestError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InvalidRequestError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/InvalidRequestError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"InvalidRequestError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/InvalidRequestError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InvalidRequestError.headers.__type\"},{\"kind\":128,\"name\":\"InvalidTokenError\",\"url\":\"classes/InvalidTokenError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InvalidTokenError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/InvalidTokenError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/InvalidTokenError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/InvalidTokenError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/InvalidTokenError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InvalidTokenError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/InvalidTokenError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"InvalidTokenError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/InvalidTokenError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InvalidTokenError.headers.__type\"},{\"kind\":128,\"name\":\"InsufficientScopeError\",\"url\":\"classes/InsufficientScopeError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InsufficientScopeError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/InsufficientScopeError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/InsufficientScopeError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/InsufficientScopeError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/InsufficientScopeError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InsufficientScopeError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/InsufficientScopeError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"InsufficientScopeError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/InsufficientScopeError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InsufficientScopeError.headers.__type\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,37.396]],[\"comment/0\",[]],[\"name/1\",[1,37.396]],[\"comment/1\",[]],[\"name/2\",[2,37.396]],[\"comment/2\",[]],[\"name/3\",[3,37.396]],[\"comment/3\",[]],[\"name/4\",[4,37.396]],[\"comment/4\",[]],[\"name/5\",[5,37.396]],[\"comment/5\",[]],[\"name/6\",[6,37.396]],[\"comment/6\",[]],[\"name/7\",[7,37.396]],[\"comment/7\",[]],[\"name/8\",[8,37.396]],[\"comment/8\",[]],[\"name/9\",[9,37.396]],[\"comment/9\",[]],[\"name/10\",[10,37.396]],[\"comment/10\",[]],[\"name/11\",[11,37.396]],[\"comment/11\",[]],[\"name/12\",[12,37.396]],[\"comment/12\",[]],[\"name/13\",[13,37.396]],[\"comment/13\",[]],[\"name/14\",[14,37.396]],[\"comment/14\",[]],[\"name/15\",[15,37.396]],[\"comment/15\",[]],[\"name/16\",[16,37.396]],[\"comment/16\",[]],[\"name/17\",[17,37.396]],[\"comment/17\",[]],[\"name/18\",[18,37.396]],[\"comment/18\",[]],[\"name/19\",[19,37.396]],[\"comment/19\",[]],[\"name/20\",[20,37.396]],[\"comment/20\",[]],[\"name/21\",[21,37.396]],[\"comment/21\",[]],[\"name/22\",[22,37.396]],[\"comment/22\",[]],[\"name/23\",[23,37.396]],[\"comment/23\",[]],[\"name/24\",[24,37.396]],[\"comment/24\",[]],[\"name/25\",[25,37.396]],[\"comment/25\",[]],[\"name/26\",[26,26.102]],[\"comment/26\",[]],[\"name/27\",[27,26.102]],[\"comment/27\",[]],[\"name/28\",[28,26.102]],[\"comment/28\",[]],[\"name/29\",[29,26.102]],[\"comment/29\",[]],[\"name/30\",[30,26.102]],[\"comment/30\",[]],[\"name/31\",[31,18.744,32,18.744]],[\"comment/31\",[]],[\"name/32\",[33,37.396]],[\"comment/32\",[]],[\"name/33\",[26,26.102]],[\"comment/33\",[]],[\"name/34\",[34,28.685]],[\"comment/34\",[]],[\"name/35\",[27,26.102]],[\"comment/35\",[]],[\"name/36\",[28,26.102]],[\"comment/36\",[]],[\"name/37\",[29,26.102]],[\"comment/37\",[]],[\"name/38\",[30,26.102]],[\"comment/38\",[]],[\"name/39\",[31,18.744,32,18.744]],[\"comment/39\",[]],[\"name/40\",[35,37.396]],[\"comment/40\",[]],[\"name/41\",[26,26.102]],[\"comment/41\",[]],[\"name/42\",[34,28.685]],[\"comment/42\",[]],[\"name/43\",[27,26.102]],[\"comment/43\",[]],[\"name/44\",[28,26.102]],[\"comment/44\",[]],[\"name/45\",[29,26.102]],[\"comment/45\",[]],[\"name/46\",[30,26.102]],[\"comment/46\",[]],[\"name/47\",[31,18.744,32,18.744]],[\"comment/47\",[]],[\"name/48\",[36,37.396]],[\"comment/48\",[]],[\"name/49\",[26,26.102]],[\"comment/49\",[]],[\"name/50\",[34,28.685]],[\"comment/50\",[]],[\"name/51\",[27,26.102]],[\"comment/51\",[]],[\"name/52\",[28,26.102]],[\"comment/52\",[]],[\"name/53\",[29,26.102]],[\"comment/53\",[]],[\"name/54\",[30,26.102]],[\"comment/54\",[]],[\"name/55\",[31,18.744,32,18.744]],[\"comment/55\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":30,\"name\":{\"30\":{},\"38\":{},\"46\":{},\"54\":{}},\"comment\":{}}],[\"agent\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"audience\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"auth\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"authenticate\",{\"_index\":32,\"name\":{\"31\":{},\"39\":{},\"47\":{},\"55\":{}},\"comment\":{}}],[\"authoptions\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"authresult\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"claimcheck\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"claimequals\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"claimincludes\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"clocktolerance\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"code\",{\"_index\":34,\"name\":{\"34\":{},\"42\":{},\"50\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":26,\"name\":{\"26\":{},\"33\":{},\"41\":{},\"49\":{}},\"comment\":{}}],[\"cooldownduration\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"header\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"headers\",{\"_index\":29,\"name\":{\"29\":{},\"37\":{},\"45\":{},\"53\":{}},\"comment\":{}}],[\"insufficientscopeerror\",{\"_index\":36,\"name\":{\"48\":{}},\"comment\":{}}],[\"invalidrequesterror\",{\"_index\":33,\"name\":{\"32\":{}},\"comment\":{}}],[\"invalidtokenerror\",{\"_index\":35,\"name\":{\"40\":{}},\"comment\":{}}],[\"issuer\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"issuerbaseurl\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"jsonprimitive\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"jwksuri\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"maxtokenage\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"payload\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"requiredscopes\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"scopeincludesany\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"secret\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"status\",{\"_index\":27,\"name\":{\"27\":{},\"35\":{},\"43\":{},\"51\":{}},\"comment\":{}}],[\"statuscode\",{\"_index\":28,\"name\":{\"28\":{},\"36\":{},\"44\":{},\"52\":{}},\"comment\":{}}],[\"strict\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"timeoutduration\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"token\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"tokensigningalg\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"unauthorizederror\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"validators\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"www\",{\"_index\":31,\"name\":{\"31\":{},\"39\":{},\"47\":{},\"55\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":256,\"name\":\"AuthOptions\",\"url\":\"interfaces/AuthOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"authRequired\",\"url\":\"interfaces/AuthOptions.html#authRequired\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"issuerBaseURL\",\"url\":\"interfaces/AuthOptions.html#issuerBaseURL\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"interfaces/AuthOptions.html#audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"issuer\",\"url\":\"interfaces/AuthOptions.html#issuer\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"jwksUri\",\"url\":\"interfaces/AuthOptions.html#jwksUri\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"agent\",\"url\":\"interfaces/AuthOptions.html#agent\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"cooldownDuration\",\"url\":\"interfaces/AuthOptions.html#cooldownDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"timeoutDuration\",\"url\":\"interfaces/AuthOptions.html#timeoutDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"cacheMaxAge\",\"url\":\"interfaces/AuthOptions.html#cacheMaxAge\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"interfaces/AuthOptions.html#validators\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"clockTolerance\",\"url\":\"interfaces/AuthOptions.html#clockTolerance\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"maxTokenAge\",\"url\":\"interfaces/AuthOptions.html#maxTokenAge\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"strict\",\"url\":\"interfaces/AuthOptions.html#strict\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"secret\",\"url\":\"interfaces/AuthOptions.html#secret\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":1024,\"name\":\"tokenSigningAlg\",\"url\":\"interfaces/AuthOptions.html#tokenSigningAlg\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"AuthOptions\"},{\"kind\":64,\"name\":\"auth\",\"url\":\"functions/auth.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimCheck\",\"url\":\"functions/claimCheck.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimEquals\",\"url\":\"functions/claimEquals.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimIncludes\",\"url\":\"functions/claimIncludes.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"requiredScopes\",\"url\":\"functions/requiredScopes.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"scopeIncludesAny\",\"url\":\"functions/scopeIncludesAny.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"AuthResult\",\"url\":\"interfaces/AuthResult.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"header\",\"url\":\"interfaces/AuthResult.html#header\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthResult\"},{\"kind\":1024,\"name\":\"payload\",\"url\":\"interfaces/AuthResult.html#payload\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthResult\"},{\"kind\":1024,\"name\":\"token\",\"url\":\"interfaces/AuthResult.html#token\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthResult\"},{\"kind\":4194304,\"name\":\"JSONPrimitive\",\"url\":\"types/JSONPrimitive.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"UnauthorizedError\",\"url\":\"classes/UnauthorizedError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/UnauthorizedError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/UnauthorizedError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/UnauthorizedError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/UnauthorizedError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UnauthorizedError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/UnauthorizedError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"UnauthorizedError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/UnauthorizedError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"UnauthorizedError.headers.__type\"},{\"kind\":128,\"name\":\"InvalidRequestError\",\"url\":\"classes/InvalidRequestError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InvalidRequestError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/InvalidRequestError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/InvalidRequestError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/InvalidRequestError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidRequestError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/InvalidRequestError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InvalidRequestError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/InvalidRequestError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"InvalidRequestError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/InvalidRequestError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InvalidRequestError.headers.__type\"},{\"kind\":128,\"name\":\"InvalidTokenError\",\"url\":\"classes/InvalidTokenError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InvalidTokenError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/InvalidTokenError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/InvalidTokenError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/InvalidTokenError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InvalidTokenError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/InvalidTokenError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InvalidTokenError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/InvalidTokenError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"InvalidTokenError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/InvalidTokenError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InvalidTokenError.headers.__type\"},{\"kind\":128,\"name\":\"InsufficientScopeError\",\"url\":\"classes/InsufficientScopeError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InsufficientScopeError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/InsufficientScopeError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/InsufficientScopeError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/InsufficientScopeError.html#statusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InsufficientScopeError\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/InsufficientScopeError.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InsufficientScopeError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/InsufficientScopeError.html#headers.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"InsufficientScopeError.headers\"},{\"kind\":1024,\"name\":\"WWW-Authenticate\",\"url\":\"classes/InsufficientScopeError.html#headers.__type.WWW_Authenticate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InsufficientScopeError.headers.__type\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,37.716]],[\"comment/0\",[]],[\"name/1\",[1,37.716]],[\"comment/1\",[]],[\"name/2\",[2,37.716]],[\"comment/2\",[]],[\"name/3\",[3,37.716]],[\"comment/3\",[]],[\"name/4\",[4,37.716]],[\"comment/4\",[]],[\"name/5\",[5,37.716]],[\"comment/5\",[]],[\"name/6\",[6,37.716]],[\"comment/6\",[]],[\"name/7\",[7,37.716]],[\"comment/7\",[]],[\"name/8\",[8,37.716]],[\"comment/8\",[]],[\"name/9\",[9,37.716]],[\"comment/9\",[]],[\"name/10\",[10,37.716]],[\"comment/10\",[]],[\"name/11\",[11,37.716]],[\"comment/11\",[]],[\"name/12\",[12,37.716]],[\"comment/12\",[]],[\"name/13\",[13,37.716]],[\"comment/13\",[]],[\"name/14\",[14,37.716]],[\"comment/14\",[]],[\"name/15\",[15,37.716]],[\"comment/15\",[]],[\"name/16\",[16,37.716]],[\"comment/16\",[]],[\"name/17\",[17,37.716]],[\"comment/17\",[]],[\"name/18\",[18,37.716]],[\"comment/18\",[]],[\"name/19\",[19,37.716]],[\"comment/19\",[]],[\"name/20\",[20,37.716]],[\"comment/20\",[]],[\"name/21\",[21,37.716]],[\"comment/21\",[]],[\"name/22\",[22,37.716]],[\"comment/22\",[]],[\"name/23\",[23,37.716]],[\"comment/23\",[]],[\"name/24\",[24,37.716]],[\"comment/24\",[]],[\"name/25\",[25,37.716]],[\"comment/25\",[]],[\"name/26\",[26,37.716]],[\"comment/26\",[]],[\"name/27\",[27,37.716]],[\"comment/27\",[]],[\"name/28\",[28,26.432]],[\"comment/28\",[]],[\"name/29\",[29,26.432]],[\"comment/29\",[]],[\"name/30\",[30,26.432]],[\"comment/30\",[]],[\"name/31\",[31,26.432]],[\"comment/31\",[]],[\"name/32\",[32,26.432]],[\"comment/32\",[]],[\"name/33\",[33,18.974,34,18.974]],[\"comment/33\",[]],[\"name/34\",[35,37.716]],[\"comment/34\",[]],[\"name/35\",[28,26.432]],[\"comment/35\",[]],[\"name/36\",[36,29.013]],[\"comment/36\",[]],[\"name/37\",[29,26.432]],[\"comment/37\",[]],[\"name/38\",[30,26.432]],[\"comment/38\",[]],[\"name/39\",[31,26.432]],[\"comment/39\",[]],[\"name/40\",[32,26.432]],[\"comment/40\",[]],[\"name/41\",[33,18.974,34,18.974]],[\"comment/41\",[]],[\"name/42\",[37,37.716]],[\"comment/42\",[]],[\"name/43\",[28,26.432]],[\"comment/43\",[]],[\"name/44\",[36,29.013]],[\"comment/44\",[]],[\"name/45\",[29,26.432]],[\"comment/45\",[]],[\"name/46\",[30,26.432]],[\"comment/46\",[]],[\"name/47\",[31,26.432]],[\"comment/47\",[]],[\"name/48\",[32,26.432]],[\"comment/48\",[]],[\"name/49\",[33,18.974,34,18.974]],[\"comment/49\",[]],[\"name/50\",[38,37.716]],[\"comment/50\",[]],[\"name/51\",[28,26.432]],[\"comment/51\",[]],[\"name/52\",[36,29.013]],[\"comment/52\",[]],[\"name/53\",[29,26.432]],[\"comment/53\",[]],[\"name/54\",[30,26.432]],[\"comment/54\",[]],[\"name/55\",[31,26.432]],[\"comment/55\",[]],[\"name/56\",[32,26.432]],[\"comment/56\",[]],[\"name/57\",[33,18.974,34,18.974]],[\"comment/57\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":32,\"name\":{\"32\":{},\"40\":{},\"48\":{},\"56\":{}},\"comment\":{}}],[\"agent\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"audience\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"auth\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"authenticate\",{\"_index\":34,\"name\":{\"33\":{},\"41\":{},\"49\":{},\"57\":{}},\"comment\":{}}],[\"authoptions\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"authrequired\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"authresult\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"cachemaxage\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"claimcheck\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"claimequals\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"claimincludes\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"clocktolerance\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"code\",{\"_index\":36,\"name\":{\"36\":{},\"44\":{},\"52\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":28,\"name\":{\"28\":{},\"35\":{},\"43\":{},\"51\":{}},\"comment\":{}}],[\"cooldownduration\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"header\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"headers\",{\"_index\":31,\"name\":{\"31\":{},\"39\":{},\"47\":{},\"55\":{}},\"comment\":{}}],[\"insufficientscopeerror\",{\"_index\":38,\"name\":{\"50\":{}},\"comment\":{}}],[\"invalidrequesterror\",{\"_index\":35,\"name\":{\"34\":{}},\"comment\":{}}],[\"invalidtokenerror\",{\"_index\":37,\"name\":{\"42\":{}},\"comment\":{}}],[\"issuer\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"issuerbaseurl\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"jsonprimitive\",{\"_index\":26,\"name\":{\"26\":{}},\"comment\":{}}],[\"jwksuri\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"maxtokenage\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"payload\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"requiredscopes\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"scopeincludesany\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"secret\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"status\",{\"_index\":29,\"name\":{\"29\":{},\"37\":{},\"45\":{},\"53\":{}},\"comment\":{}}],[\"statuscode\",{\"_index\":30,\"name\":{\"30\":{},\"38\":{},\"46\":{},\"54\":{}},\"comment\":{}}],[\"strict\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"timeoutduration\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"token\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"tokensigningalg\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"unauthorizederror\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"validators\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"www\",{\"_index\":33,\"name\":{\"33\":{},\"41\":{},\"49\":{},\"57\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/classes/insufficientscopeerror.html b/docs/classes/insufficientscopeerror.html index 2b68f94..ca6cc64 100644 --- a/docs/classes/insufficientscopeerror.html +++ b/docs/classes/insufficientscopeerror.html @@ -26,7 +26,7 @@

Hierarchy

+
  • Defined in packages/oauth2-bearer/src/errors.ts:57
    • @@ -69,14 +69,14 @@
    message: stringReturns InsufficientScopeError
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:62

    • Properties

    code

    code: string = 'insufficient_scope'
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:58

    • headers

    headers: {
        WWW-Authenticate: string;
    } = ...
    @@ -87,7 +87,7 @@

    Type declaration

    WWW-Authenticate: string
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:13

    • message

    message: string
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:59

    • statusCode

    statusCode: number = 403
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:60

    • Static Optional prepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
    diff --git a/docs/classes/invalidrequesterror.html b/docs/classes/invalidrequesterror.html index 92816b5..e7e3dad 100644 --- a/docs/classes/invalidrequesterror.html +++ b/docs/classes/invalidrequesterror.html @@ -28,7 +28,7 @@

    Hierarchy

    +
  • Defined in packages/oauth2-bearer/src/errors.ts:27
    • @@ -69,14 +69,14 @@
    message: stringReturns InvalidRequestError
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:32

    • Properties

    code

    code: string = 'invalid_request'
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:28

    • headers

    headers: {
        WWW-Authenticate: string;
    } = ...
    @@ -87,7 +87,7 @@

    Type declaration

    WWW-Authenticate: string
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:13

    • message

    message: string
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:29

    • statusCode

    statusCode: number = 400
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:30

    • Static Optional prepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
    diff --git a/docs/classes/invalidtokenerror.html b/docs/classes/invalidtokenerror.html index 851913b..f17a1b9 100644 --- a/docs/classes/invalidtokenerror.html +++ b/docs/classes/invalidtokenerror.html @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in packages/oauth2-bearer/src/errors.ts:42
    • @@ -67,14 +67,14 @@
    message: stringReturns InvalidTokenError
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:47

    • Properties

    code

    code: string = 'invalid_token'
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:43

    • headers

    headers: {
        WWW-Authenticate: string;
    } = ...
    @@ -85,7 +85,7 @@

    Type declaration

    WWW-Authenticate: string
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:13

    • message

    message: string
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:44

    • statusCode

    statusCode: number = 401
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:45

    • Static Optional prepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
    diff --git a/docs/classes/unauthorizederror.html b/docs/classes/unauthorizederror.html index 002e005..0f5f685 100644 --- a/docs/classes/unauthorizederror.html +++ b/docs/classes/unauthorizederror.html @@ -31,7 +31,7 @@

    Hierarchy

  • InvalidTokenError
  • InsufficientScopeError
    • +
  • Defined in packages/oauth2-bearer/src/errors.ts:10
    • @@ -71,7 +71,7 @@
    message: stringReturns UnauthorizedError
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:15

    • Properties

    @@ -83,7 +83,7 @@

    Type declaration

  • WWW-Authenticate: string
    • +
  • Defined in packages/oauth2-bearer/src/errors.ts:13

    • message

    message: string
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:11

    • statusCode

    statusCode: number = 401
    +
  • Defined in packages/oauth2-bearer/src/errors.ts:12

    • Static Optional prepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
    diff --git a/docs/functions/auth.html b/docs/functions/auth.html index db5a1e8..722efa2 100644 --- a/docs/functions/auth.html +++ b/docs/functions/auth.html @@ -40,6 +40,9 @@

    Function auth

    You must provide the audience argument (or AUDIENCE environment variable) used to match against the Access Token's aud claim.

    +

    Successful requests will have the following properties added to them:

    +
    app.get('/foo', auth(), (req, res, next) => {
      const auth = req.auth;
      auth.header; // The decoded JWT header.
      auth.payload; // The decoded JWT payload.
      auth.token; // The raw JWT token.
    });
+

    Parameters

    @@ -48,7 +51,7 @@

    Parameters

    opts: AuthOptions = {}

    Returns Handler

    +
  • Defined in packages/express-oauth2-jwt-bearer/src/index.ts:82
    • diff --git a/docs/functions/claimCheck.html b/docs/functions/claimCheck.html index 4dacab6..500e1ec 100644 --- a/docs/functions/claimCheck.html +++ b/docs/functions/claimCheck.html @@ -23,7 +23,7 @@

    Function claimCheck

    {@Link JWTPayload} and should return true if the token is valid. Raises a 401 invalid_token error if the function returns false. You can also customise the error_description which should be formatted per rfc6750.

    -
    app.use(auth());

    app.get('/admin/edit', claimCheck((claims) => {
      return claims.isAdmin && claims.roles.includes('editor');
    }, `Unexpected 'isAdmin' and 'roles' claims`), (req, res) => { ... });
+
    app.use(auth());

    app.get('/admin/edit', claimCheck((claims) => {
      return claims.isAdmin && claims.roles.includes('editor');
    }, `Unexpected 'isAdmin' and 'roles' claims`), (req, res) => { ... });
    @@ -46,7 +46,7 @@

    Returns booleanOptional errMsg: string

    Returns Handler

    +
  • Defined in packages/access-token-jwt/src/claim-check.ts:126
    • diff --git a/docs/functions/claimEquals.html b/docs/functions/claimEquals.html index f7d4df6..f5f4cca 100644 --- a/docs/functions/claimEquals.html +++ b/docs/functions/claimEquals.html @@ -34,7 +34,7 @@
    claim: string
    expected: JSONPrimitive

    Returns Handler

    +
  • Defined in packages/access-token-jwt/src/claim-check.ts:107
    • diff --git a/docs/functions/claimIncludes.html b/docs/functions/claimIncludes.html index de387bd..020cc11 100644 --- a/docs/functions/claimIncludes.html +++ b/docs/functions/claimIncludes.html @@ -34,7 +34,7 @@
    claim: string
    Rest ...expected: JSONPrimitive[]

    Returns Handler

    +
  • Defined in packages/access-token-jwt/src/claim-check.ts:90
    • diff --git a/docs/functions/requiredScopes.html b/docs/functions/requiredScopes.html index f84f707..f193c4d 100644 --- a/docs/functions/requiredScopes.html +++ b/docs/functions/requiredScopes.html @@ -32,7 +32,7 @@

    Parameters

    scopes: string | string[]

    Returns Handler

    +
  • Defined in packages/access-token-jwt/src/claim-check.ts:46
    • diff --git a/docs/functions/scopeIncludesAny.html b/docs/functions/scopeIncludesAny.html index 1b6e7c0..5e8db9e 100644 --- a/docs/functions/scopeIncludesAny.html +++ b/docs/functions/scopeIncludesAny.html @@ -32,7 +32,7 @@

    Parameters

    scopes: string | string[]

    Returns Handler

    +
  • Defined in packages/access-token-jwt/src/claim-check.ts:46
    • diff --git a/docs/interfaces/authoptions.html b/docs/interfaces/authoptions.html index ac8ba73..f58f785 100644 --- a/docs/interfaces/authoptions.html +++ b/docs/interfaces/authoptions.html @@ -18,9 +18,11 @@

    Interface AuthOptions

    Hierarchy

      -
    • AuthOptions
    @@ -28,65 +30,90 @@

    Properties

    -
    +

    Optional agent

    agent?: Agent | Agent

    An instance of http.Agent or https.Agent to pass to the http.get or https.get method options. Use when behind an http(s) proxy.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:48
    • +

    Optional audience

    audience?: string | string[]

    Expected JWT "aud" (Audience) Claim value(s). REQUIRED: You can also provide the AUDIENCE environment variable.

    +
    +

    Optional authRequired

    +
    authRequired?: boolean
    +

    True if a valid Access Token JWT should be required for all routes. +Defaults to true.

    +
    +
    +

    Optional cacheMaxAge

    +
    cacheMaxAge?: number
    +

    Maximum time (in milliseconds) between successful HTTP requests to the +JWKS and Discovery endpoint. +Default is 600000 (10 minutes).

    +
    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:69
    • +

    Optional clockTolerance

    clockTolerance?: number

    Clock tolerance (in secs) used when validating the exp and iat claim. Defaults to 5 secs.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:98
    • +

    Optional cooldownDuration

    cooldownDuration?: number

    Duration in ms for which no more HTTP requests to the JWKS Uri endpoint will be triggered after a previous successful fetch. Default is 30000.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:55
    • +

    Optional issuer

    issuer?: string

    Expected JWT "iss" (Issuer) Claim value. REQUIRED (if you don't include {@Link AuthOptions.issuerBaseURL}) You can also provide the ISSUER environment variable.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:34
    • +

    Optional issuerBaseURL

    issuerBaseURL?: string

    Base url, used to find the authorization server's app metadata per @@ -97,9 +124,10 @@

    OptionalISSUER_BASE_URL environment variable.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:21
    • +

    Optional jwksUri

    jwksUri?: string

    Url for the authorization server's JWKS to find the public key to verify @@ -107,25 +135,28 @@

    OptionalJWKS_URI environment variable.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:42
    • +

    Optional maxTokenAge

    maxTokenAge?: number

    Maximum age (in secs) from when a token was issued to when it can no longer be accepted.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:104
    • +

    Optional secret

    secret?: string

    Secret to verify an Access Token JWT signed with a symmetric algorithm. By default this SDK validates tokens signed with asymmetric algorithms.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:118
    • +

    Optional strict

    strict?: boolean

    If set to true the token validation will strictly follow @@ -133,18 +164,20 @@

    Optionalhttps://datatracker.ietf.org/doc/html/draft-ietf-oauth-access-token-jwt-12 Defaults to false.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:112
    • +

    Optional timeoutDuration

    timeoutDuration?: number
    -

    Timeout in ms for the HTTP request. When reached the request will be -aborted. +

    Timeout in ms for HTTP requests to the JWKS and Discovery endpoint. When +reached the request will be aborted. Default is 5000.

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:62
    • +

    Optional tokenSigningAlg

    tokenSigningAlg?: string

    You must provide this if your tokens are signed with symmetric algorithms @@ -153,9 +186,10 @@

    Optional

    -
    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:127
    • +

    Optional validators

    validators?: Partial<Validators>

    Pass in custom validators to override the existing validation behavior on @@ -163,8 +197,9 @@

    Optional {
    validators: {
    // Disable issuer validation by passing `false`
    iss: false,
    // Add validation for a custom claim to equal a passed in string
    org_id: 'my_org_123'
    // Add validation for a custom claim, by passing in a function that
    // accepts:
    // roles: the value of the claim
    // claims: an object containing the JWTPayload
    // header: an object representing the JWTHeader
    roles: (roles, claims, header) => roles.includes('editor') && claims.isAdmin
    }
    }

    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:92
    • @@ -190,17 +225,19 @@

    AuthOptions

    +
  • agent?
    • +
  • audience?
    • +
  • authRequired?
    • +
  • cacheMaxAge?
    • +
  • clockTolerance?
    • +
  • cooldownDuration?
    • +
  • issuer?
    • +
  • issuerBaseURL?
    • +
  • jwksUri?
    • +
  • maxTokenAge?
    • +
  • secret?
    • +
  • strict?
    • +
  • timeoutDuration?
    • +
  • tokenSigningAlg?
    • +
  • validators?
    • \ No newline at end of file diff --git a/docs/interfaces/authresult.html b/docs/interfaces/authresult.html index 92ccb22..0ecedc1 100644 --- a/docs/interfaces/authresult.html +++ b/docs/interfaces/authresult.html @@ -20,7 +20,7 @@

    Hierarchy

    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:130
    • @@ -40,21 +40,21 @@

    header

    The Access Token JWT header.

    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:134

    • payload

    payload: JWTPayload

    The Access Token JWT payload.

    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:138

    • token

    token: string

    The raw Access Token JWT

    +
  • Defined in packages/access-token-jwt/src/jwt-verifier.ts:142
    • diff --git a/docs/types/JSONPrimitive.html b/docs/types/JSONPrimitive.html index f885088..2f08246 100644 --- a/docs/types/JSONPrimitive.html +++ b/docs/types/JSONPrimitive.html @@ -17,7 +17,7 @@

    Type alias JSONPrimitive

    JSONPrimitive: string | number | boolean | null
    +
  • Defined in packages/access-token-jwt/src/claim-check.ts:8
    • diff --git a/package-lock.json b/package-lock.json index 9e1c4a5..b9b1703 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8740,7 +8740,7 @@ } }, "packages/express-oauth2-jwt-bearer": { - "version": "1.3.0", + "version": "1.4.0", "license": "MIT", "dependencies": { "jose": "^4.13.1" diff --git a/packages/express-oauth2-jwt-bearer/CHANGELOG.md b/packages/express-oauth2-jwt-bearer/CHANGELOG.md index 799b7bb..dde671c 100644 --- a/packages/express-oauth2-jwt-bearer/CHANGELOG.md +++ b/packages/express-oauth2-jwt-bearer/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log +## [v1.4.0](https://github.com/auth0/node-oauth2-jwt-bearer/tree/v1.4.0) (2023-04-03) +[Full Changelog](https://github.com/auth0/node-oauth2-jwt-bearer/compare/v1.3.0...v1.4.0) + +**Added** +- Cache max age [\#98](https://github.com/auth0/node-oauth2-jwt-bearer/pull/98) ([adamjmcgrath](https://github.com/adamjmcgrath)) +- Add authRequired option [\#97](https://github.com/auth0/node-oauth2-jwt-bearer/pull/97) ([adamjmcgrath](https://github.com/adamjmcgrath)) + ## [v1.3.0](https://github.com/auth0/node-oauth2-jwt-bearer/tree/v1.3.0) (2022-12-19) [Full Changelog](https://github.com/auth0/node-oauth2-jwt-bearer/compare/v1.2.0...v1.3.0) diff --git a/packages/express-oauth2-jwt-bearer/package.json b/packages/express-oauth2-jwt-bearer/package.json index 1d25a3c..2ff72fc 100644 --- a/packages/express-oauth2-jwt-bearer/package.json +++ b/packages/express-oauth2-jwt-bearer/package.json @@ -1,7 +1,7 @@ { "name": "express-oauth2-jwt-bearer", "description": "Authentication middleware for Express.js that validates JWT bearer access tokens.", - "version": "1.3.0", + "version": "1.4.0", "main": "dist/index.js", "types": "dist/index.d.ts", "scripts": {