From b053dc8df44cb315d7a3174c2355d7a70cf3d93d Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 11 Nov 2022 18:02:15 +0000 Subject: [PATCH] Release v2.10.0 (#417) --- CHANGELOG.md | 6 +++ docs/functions/attemptSilentLogin.html | 2 +- docs/functions/auth.html | 2 +- docs/functions/claimCheck.html | 2 +- docs/functions/claimEquals.html | 2 +- docs/functions/claimIncludes.html | 2 +- docs/functions/requiresAuth.html | 2 +- docs/interfaces/AccessToken.html | 12 ++--- docs/interfaces/ConfigParams.html | 60 ++++++++++++------------ docs/interfaces/CookieConfigParams.html | 14 +++--- docs/interfaces/LoginOptions.html | 8 ++-- docs/interfaces/LogoutOptions.html | 6 +-- docs/interfaces/OpenidRequest.html | 4 +- docs/interfaces/OpenidResponse.html | 4 +- docs/interfaces/RefreshParams.html | 4 +- docs/interfaces/RequestContext.html | 16 +++---- docs/interfaces/ResponseContext.html | 6 +-- docs/interfaces/Session.html | 12 ++--- docs/interfaces/SessionConfigParams.html | 16 +++---- docs/interfaces/SessionStore.html | 8 ++-- docs/interfaces/SessionStorePayload.html | 6 +-- docs/interfaces/TokenParameters.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 24 files changed, 104 insertions(+), 98 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67956952..6063e40e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.10.0](https://github.com/auth0/express-openid-connect/tree/v2.10.0) (2022-11-11) +[Full Changelog](https://github.com/auth0/express-openid-connect/compare/v2.9.0...v2.10.0) + +**Added** +- Add option to override transaction cookie name [\#414](https://github.com/auth0/express-openid-connect/pull/414) ([MatthewBacalakis](https://github.com/MatthewBacalakis)) + ## [v2.9.0](https://github.com/auth0/express-openid-connect/tree/v2.9.0) (2022-10-17) [Full Changelog](https://github.com/auth0/express-openid-connect/compare/v2.8.0...v2.9.0) diff --git a/docs/functions/attemptSilentLogin.html b/docs/functions/attemptSilentLogin.html index 168add1e..1889a05d 100644 --- a/docs/functions/attemptSilentLogin.html +++ b/docs/functions/attemptSilentLogin.html @@ -26,7 +26,7 @@

Function attemptSilentLogin

Returns RequestHandler

+
  • Defined in index.d.ts:888
    • diff --git a/docs/functions/auth.html b/docs/functions/auth.html index b281cfdc..0b17129f 100644 --- a/docs/functions/auth.html +++ b/docs/functions/auth.html @@ -33,7 +33,7 @@

    Parameters

    Optional params: ConfigParams

    Returns RequestHandler

    +
  • Defined in index.d.ts:788
    • diff --git a/docs/functions/claimCheck.html b/docs/functions/claimCheck.html index c44c38db..90748875 100644 --- a/docs/functions/claimCheck.html +++ b/docs/functions/claimCheck.html @@ -43,7 +43,7 @@
    claims: IdTokenClaims

    Returns boolean

    Returns RequestHandler

    +
  • Defined in index.d.ts:868
    • diff --git a/docs/functions/claimEquals.html b/docs/functions/claimEquals.html index 30948c19..1959b318 100644 --- a/docs/functions/claimEquals.html +++ b/docs/functions/claimEquals.html @@ -36,7 +36,7 @@
    value: stringReturns RequestHandler
    +
  • Defined in index.d.ts:829
    • diff --git a/docs/functions/claimIncludes.html b/docs/functions/claimIncludes.html index 24ccd00d..7d085464 100644 --- a/docs/functions/claimIncludes.html +++ b/docs/functions/claimIncludes.html @@ -36,7 +36,7 @@
    Rest Returns RequestHandler
    +
  • Defined in index.d.ts:849
    • diff --git a/docs/functions/requiresAuth.html b/docs/functions/requiresAuth.html index 4e876a1d..502cae77 100644 --- a/docs/functions/requiresAuth.html +++ b/docs/functions/requiresAuth.html @@ -42,7 +42,7 @@
    req: Returns boolean

    Returns RequestHandler

    +
  • Defined in index.d.ts:810
    • diff --git a/docs/interfaces/AccessToken.html b/docs/interfaces/AccessToken.html index 700e7215..b9e17738 100644 --- a/docs/interfaces/AccessToken.html +++ b/docs/interfaces/AccessToken.html @@ -20,7 +20,7 @@

    Hierarchy

    • AccessToken
    +
  • Defined in index.d.ts:717
    • @@ -45,14 +45,14 @@

    access_token

    The access token itself, can be an opaque string, JWT, or non-JWT token.

    +
  • Defined in index.d.ts:721

    • expires_in

    expires_in: number

    Number of seconds until the access token expires.

    +
  • Defined in index.d.ts:731

    • isExpired

    isExpired: (() => boolean)
    @@ -67,14 +67,14 @@

    Type declaration

    Returns boolean

    +
  • Defined in index.d.ts:736

    • token_type

    token_type: string

    The type of access token, Usually "Bearer".

    +
  • Defined in index.d.ts:726

    • Methods

    @@ -93,7 +93,7 @@

    Parameters

    Optional params: RefreshParams

    Returns Promise<AccessToken>

    +
  • Defined in index.d.ts:748
    • diff --git a/docs/interfaces/ConfigParams.html b/docs/interfaces/ConfigParams.html index f3f61de0..7be79b28 100644 --- a/docs/interfaces/ConfigParams.html +++ b/docs/interfaces/ConfigParams.html @@ -27,7 +27,7 @@

    Hierarchy

    • ConfigParams
    +
  • Defined in index.d.ts:247
    • @@ -107,7 +107,7 @@
    decodedState: {
       
    [key: string]: any

    Returns Session | Promise<Session>

    +
  • Defined in index.d.ts:410

    • Optional attemptSilentLogin

    attemptSilentLogin?: boolean
    @@ -119,21 +119,21 @@

    Optionalfalse

    +
  • Defined in index.d.ts:373

    • Optional auth0Logout

    auth0Logout?: boolean

    Boolean value to enable idpLogout with an Auth0 custom domain

    +
  • Defined in index.d.ts:264

    • Optional authRequired

    authRequired?: boolean

    Require authentication for all routes.

    +
  • Defined in index.d.ts:448

    • Optional authorizationParams

    authorizationParams?: AuthorizationParameters
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in index.d.ts:311

    • Optional baseURL

    baseURL?: string
    @@ -162,7 +162,7 @@

    Optional

    +
  • Defined in index.d.ts:332

    • Optional clientAssertionSigningAlg

    clientAssertionSigningAlg?: "RS256" | "RS384" | "RS512" | "PS256" | "PS384" | "PS512" | "ES256" | "ES256K" | "ES384" | "ES512" | "EdDSA"
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in index.d.ts:535

    • Optional clientAssertionSigningKey

    clientAssertionSigningKey?: KeyObject | KeyInput | JSONWebKey
    @@ -188,14 +188,14 @@

    Optional

    +
  • Defined in index.d.ts:527

    • Optional clientAuthMethod

    clientAuthMethod?: string

    String value for the client's authentication method. Default is none when using response_type='id_token', private_key_jwt when using a clientAssertionSigningKey, otherwise client_secret_basic.

    +
  • Defined in index.d.ts:485

    • Optional clientID

    clientID?: string
    @@ -203,7 +203,7 @@

    Optional

    +
  • Defined in index.d.ts:338

    • Optional clientSecret

    clientSecret?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in index.d.ts:345

    • Optional clockTolerance

    clockTolerance?: number
    @@ -220,7 +220,7 @@

    Optional

    +
  • Defined in index.d.ts:351

    • Optional enableTelemetry

    enableTelemetry?: boolean
    @@ -228,7 +228,7 @@

    OptionalAuth0-Client header. Default is `true

    +
  • Defined in index.d.ts:357

    • Optional errorOnRequiredAuth

    errorOnRequiredAuth?: boolean
    @@ -236,7 +236,7 @@

    Optionalfalse

    +
  • Defined in index.d.ts:363

    • Optional getLoginState

    getLoginState?: ((req: OpenidRequest, options: LoginOptions) => object)
    @@ -270,28 +270,28 @@
    req: LoginOptions

    Returns object

    +
  • Defined in index.d.ts:391

    • Optional httpTimeout

    httpTimeout?: number

    Http timeout for oidc client requests in milliseconds. Default is 5000. Minimum is 500.

    +
  • Defined in index.d.ts:556

    • Optional httpUserAgent

    httpUserAgent?: string

    Optional User-Agent header value for oidc client requests. Default is express-openid-connect/{version}.

    +
  • Defined in index.d.ts:561

    • Optional idTokenSigningAlg

    idTokenSigningAlg?: string

    String value for the expected ID token algorithm. Default is 'RS256'

    +
  • Defined in index.d.ts:431

    • Optional identityClaimFilter

    identityClaimFilter?: string[]
    @@ -299,14 +299,14 @@

    Optional['aud', 'iss', 'iat', 'exp', 'nbf', 'nonce', 'azp', 'auth_time', 's_hash', 'at_hash', 'c_hash' ]

    +
  • Defined in index.d.ts:421

    • Optional idpLogout

    idpLogout?: boolean

    Boolean value to log the user out from the identity provider on application logout. Default is false

    +
  • Defined in index.d.ts:426

    • Optional issuerBaseURL

    issuerBaseURL?: string
    @@ -314,7 +314,7 @@

    Optional

    +
  • Defined in index.d.ts:437

    • Optional legacySameSiteCookie

    legacySameSiteCookie?: boolean
    @@ -322,7 +322,7 @@

    Optional

    +
  • Defined in index.d.ts:443

    • Optional logoutParams

    logoutParams?: {
        [key: string]: any;
    }
    @@ -334,7 +334,7 @@

    Type declaration

  • [key: string]: any
    • +
  • Defined in index.d.ts:316

    • Optional routes

    routes?: {
        callback?: string;
        login?: string | false;
        logout?: string | false;
        postLogoutRedirect?: string;
    }
    @@ -362,7 +362,7 @@
    Optional postLogout The user will be redirected to this after a logout has been performed.

    +
  • Defined in index.d.ts:453

    • Optional secret

    secret?: string | string[]
    @@ -372,28 +372,28 @@

    Optional

    +
  • Defined in index.d.ts:254

    • Optional session

    session?: SessionConfigParams

    Object defining application session cookie attributes.

    +
  • Defined in index.d.ts:259

    • Optional tokenEndpointParams

    tokenEndpointParams?: TokenParameters

    Additional request body properties to be sent to the token_endpoint during authorization code exchange or token refresh.

    +
  • Defined in index.d.ts:551

    • Optional transactionCookie

    -
    transactionCookie?: Pick<CookieConfigParams, "sameSite">
    +
    transactionCookie?: Pick<CookieConfigParams, "sameSite"> & {
        name?: string;
    }

    Configuration parameters used for the transaction cookie.

    +
  • Defined in index.d.ts:480
    • diff --git a/docs/interfaces/CookieConfigParams.html b/docs/interfaces/CookieConfigParams.html index d8513e34..e97e14dd 100644 --- a/docs/interfaces/CookieConfigParams.html +++ b/docs/interfaces/CookieConfigParams.html @@ -20,7 +20,7 @@

    Hierarchy

    • CookieConfigParams
    +
  • Defined in index.d.ts:676
    • @@ -44,7 +44,7 @@

    OptionalResponse cookie as domain

    +
  • Defined in index.d.ts:681

    • Optional httpOnly

    httpOnly?: boolean
    @@ -53,7 +53,7 @@

    Optionaltrue.

    +
  • Defined in index.d.ts:700

    • Optional path

    path?: string
    @@ -61,7 +61,7 @@

    OptionalResponse cookie as path

    +
  • Defined in index.d.ts:687

    • Optional sameSite

    sameSite?: string
    @@ -70,7 +70,7 @@

    Optional

    +
  • Defined in index.d.ts:714

    • Optional secure

    secure?: boolean
    @@ -79,7 +79,7 @@

    OptionalbaseURL.

    +
  • Defined in index.d.ts:707

    • Optional transient

    transient?: boolean
    @@ -87,7 +87,7 @@

    Optionalfalse

    +
  • Defined in index.d.ts:693
    • diff --git a/docs/interfaces/LoginOptions.html b/docs/interfaces/LoginOptions.html index 8df1c87b..879f97da 100644 --- a/docs/interfaces/LoginOptions.html +++ b/docs/interfaces/LoginOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    • LoginOptions
    +
  • Defined in index.d.ts:198
    • @@ -43,21 +43,21 @@

    Optional

    Override the default authorizationParams

    +
  • Defined in index.d.ts:202

    • Optional returnTo

    returnTo?: string

    URL to return to after login, overrides the Default is Request.originalUrl

    +
  • Defined in index.d.ts:207

    • Optional silent

    silent?: boolean

    Used by attemptSilentLogin to swallow callback errors on silent login.

    +
  • Defined in index.d.ts:212
    • diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 4bd85426..a58cf97f 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    • LogoutOptions
    +
  • Defined in index.d.ts:218
    • @@ -47,14 +47,14 @@

    Type declaration

  • [key: string]: any
    • +
  • Defined in index.d.ts:227

    • Optional returnTo

    returnTo?: string

    URL to returnTo after logout, overrides the Default in routes.postLogoutRedirect

    +
  • Defined in index.d.ts:222
    • diff --git a/docs/interfaces/OpenidRequest.html b/docs/interfaces/OpenidRequest.html index 3d628207..907bfc3a 100644 --- a/docs/interfaces/OpenidRequest.html +++ b/docs/interfaces/OpenidRequest.html @@ -30,7 +30,7 @@

    Hierarchy

    • OpenidRequest
    +
  • Defined in index.d.ts:42
    • @@ -49,7 +49,7 @@

    oidc

    +
  • Defined in index.d.ts:46
    • diff --git a/docs/interfaces/OpenidResponse.html b/docs/interfaces/OpenidResponse.html index 3af7c7e6..7a691fb2 100644 --- a/docs/interfaces/OpenidResponse.html +++ b/docs/interfaces/OpenidResponse.html @@ -30,7 +30,7 @@

    Hierarchy

    • OpenidResponse
    +
  • Defined in index.d.ts:63
    • @@ -49,7 +49,7 @@

    oidc

    +
  • Defined in index.d.ts:67
    • diff --git a/docs/interfaces/RefreshParams.html b/docs/interfaces/RefreshParams.html index 3ac9de77..cc44c4b7 100644 --- a/docs/interfaces/RefreshParams.html +++ b/docs/interfaces/RefreshParams.html @@ -20,7 +20,7 @@

    Hierarchy

    • RefreshParams
    +
  • Defined in index.d.ts:751
    • @@ -36,7 +36,7 @@

    Properties

    Optional tokenEndpointParams

    tokenEndpointParams?: TokenParameters
    +
  • Defined in index.d.ts:752
    • diff --git a/docs/interfaces/RequestContext.html b/docs/interfaces/RequestContext.html index cffd20b5..3ec51a98 100644 --- a/docs/interfaces/RequestContext.html +++ b/docs/interfaces/RequestContext.html @@ -26,7 +26,7 @@

    Hierarchy

    • RequestContext
    +
  • Defined in index.d.ts:83
    • @@ -54,7 +54,7 @@

    OptionalSee: https://auth0.com/docs/protocols/oidc#access-tokens

    +
  • Defined in index.d.ts:101

    • Optional idToken

    idToken?: string
    @@ -62,14 +62,14 @@

    OptionalSee: https://auth0.com/docs/protocols/oidc#id-tokens

    +
  • Defined in index.d.ts:94

    • Optional idTokenClaims

    idTokenClaims?: IdTokenClaims

    An object containing all the claims of the ID Token.

    +
  • Defined in index.d.ts:113

    • isAuthenticated

    isAuthenticated: (() => boolean)
    @@ -84,7 +84,7 @@

    Type declaration

    Returns boolean

    +
  • Defined in index.d.ts:87

    • Optional refreshToken

    refreshToken?: string
    @@ -92,7 +92,7 @@

    OptionalSee: https://auth0.com/docs/tokens/concepts/refresh-tokens

    +
  • Defined in index.d.ts:108

    • Optional user

    user?: Record<string, any>
    @@ -100,7 +100,7 @@

    OptionalidentityClaimFilter removed.

    +
  • Defined in index.d.ts:119

    • Methods

    @@ -114,7 +114,7 @@

    fetchUserInfoReturns Promise<UserinfoResponse<UnknownObject, UnknownObject>>

    +
  • Defined in index.d.ts:134
    • diff --git a/docs/interfaces/ResponseContext.html b/docs/interfaces/ResponseContext.html index c4fa2410..6919458c 100644 --- a/docs/interfaces/ResponseContext.html +++ b/docs/interfaces/ResponseContext.html @@ -26,7 +26,7 @@

    Hierarchy

    • ResponseContext
    +
  • Defined in index.d.ts:149
    • @@ -61,7 +61,7 @@

    Parameters

    Optional opts: LoginOptions

    Returns Promise<void>

    +
  • Defined in index.d.ts:165

    • logout

    logout: ((opts?: LogoutOptions) => Promise<void>)
    @@ -84,7 +84,7 @@

    Parameters

    Optional opts: LogoutOptions

    Returns Promise<void>

    +
  • Defined in index.d.ts:177
    • diff --git a/docs/interfaces/Session.html b/docs/interfaces/Session.html index 76ee9df5..a06c4b7a 100644 --- a/docs/interfaces/Session.html +++ b/docs/interfaces/Session.html @@ -26,7 +26,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in index.d.ts:15
    • @@ -46,29 +46,29 @@

    Properties

    access_token

    access_token: string
    +
  • Defined in index.d.ts:20

    • expires_at

    expires_at: string
    +
  • Defined in index.d.ts:23

    • id_token

    id_token: string

    Values stored in an authentication session

    +
  • Defined in index.d.ts:19

    • refresh_token

    refresh_token: string
    +
  • Defined in index.d.ts:21

    • token_type

    token_type: string
    +
  • Defined in index.d.ts:22
    • diff --git a/docs/interfaces/SessionConfigParams.html b/docs/interfaces/SessionConfigParams.html index 93834c11..6b24478b 100644 --- a/docs/interfaces/SessionConfigParams.html +++ b/docs/interfaces/SessionConfigParams.html @@ -23,7 +23,7 @@

    Hierarchy

    • SessionConfigParams
    +
  • Defined in index.d.ts:615
    • @@ -50,14 +50,14 @@

    Optional

    +
  • Defined in index.d.ts:668

    • Optional cookie

    cookie?: CookieConfigParams

    Configuration parameters used for the session cookie and transient cookies.

    +
  • Defined in index.d.ts:673

    • Optional genid

    genid?: ((req: OpenidRequest) => string)
    @@ -84,7 +84,7 @@

    Parameters

    req: OpenidRequest

    Returns string

    +
  • Defined in index.d.ts:644

    • Optional name

    name?: string
    @@ -93,7 +93,7 @@

    OptionalappSession.

    +
  • Defined in index.d.ts:621

    • Optional rolling

    rolling?: boolean
    @@ -104,7 +104,7 @@

    Optionaltrue.

    +
  • Defined in index.d.ts:653

    • Optional rollingDuration

    rollingDuration?: number
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in index.d.ts:660

    • Optional store

    store?: SessionStore
    @@ -124,7 +124,7 @@

    Optionalexpress-session stores.

    +
  • Defined in index.d.ts:630
    • diff --git a/docs/interfaces/SessionStore.html b/docs/interfaces/SessionStore.html index 277fd3d3..c0eea902 100644 --- a/docs/interfaces/SessionStore.html +++ b/docs/interfaces/SessionStore.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in index.d.ts:586
    • @@ -64,7 +64,7 @@
    Optional err: Returns void

    Returns void

    +
  • Defined in index.d.ts:607

    • get

    Returns void

     +
  • Defined in index.d.ts:590

    • set

    Returns void

    +
  • Defined in index.d.ts:598
    • diff --git a/docs/interfaces/SessionStorePayload.html b/docs/interfaces/SessionStorePayload.html index 241d6225..76f70cc6 100644 --- a/docs/interfaces/SessionStorePayload.html +++ b/docs/interfaces/SessionStorePayload.html @@ -20,7 +20,7 @@

    Hierarchy

    • SessionStorePayload
    +
  • Defined in index.d.ts:564
    • @@ -39,7 +39,7 @@

    data

    The session data.

    +
  • Defined in index.d.ts:583

    • header

    header: {
        exp: number;
        iat: number;
        uat: number;
    }
    @@ -59,7 +59,7 @@
    uat:

    timestamp (in secs) when the session was last touched.

    +
  • Defined in index.d.ts:565
    • diff --git a/docs/interfaces/TokenParameters.html b/docs/interfaces/TokenParameters.html index fd0a81b1..7da315eb 100644 --- a/docs/interfaces/TokenParameters.html +++ b/docs/interfaces/TokenParameters.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: unknown
    +
  • Defined in index.d.ts:755
    • diff --git a/package-lock.json b/package-lock.json index 22cd4b78..a51e989d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "express-openid-connect", - "version": "2.9.0", + "version": "2.10.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "express-openid-connect", - "version": "2.9.0", + "version": "2.10.0", "license": "MIT", "dependencies": { "base64url": "^3.0.1", diff --git a/package.json b/package.json index ebb4b638..de873e2c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "express-openid-connect", - "version": "2.9.0", + "version": "2.10.0", "description": "Express middleware to protect web applications using OpenID Connect.", "homepage": "https://github.com/auth0/express-openid-connect", "license": "MIT",