From 9acd2f4861bd500ef99dc3149c6ea61ca6789e05 Mon Sep 17 00:00:00 2001 From: adamjmcgrath Date: Wed, 19 Apr 2023 17:52:15 +0100 Subject: [PATCH] Release v2.15.0 --- 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/CallbackOptions.html | 6 +-- docs/interfaces/ConfigParams.html | 62 ++++++++++++------------ 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 | 8 +-- docs/interfaces/Session.html | 12 ++--- docs/interfaces/SessionConfigParams.html | 26 +++++----- docs/interfaces/SessionStore.html | 8 +-- docs/interfaces/SessionStorePayload.html | 6 +-- docs/interfaces/TokenParameters.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 25 files changed, 114 insertions(+), 108 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ae4bb32b..eab80d99 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.15.0](https://github.com/auth0/express-openid-connect/tree/v2.15.0) (2023-04-19) +[Full Changelog](https://github.com/auth0/express-openid-connect/compare/v2.14.0...v2.15.0) + +**Added** +- Make genid async [\#464](https://github.com/auth0/express-openid-connect/pull/464) ([Will956](https://github.com/Will956)) + ## [v2.14.0](https://github.com/auth0/express-openid-connect/tree/v2.14.0) (2023-04-13) [Full Changelog](https://github.com/auth0/express-openid-connect/compare/v2.13.0...v2.14.0) diff --git a/docs/functions/attemptSilentLogin.html b/docs/functions/attemptSilentLogin.html index 96c2b280..3886f7af 100644 --- a/docs/functions/attemptSilentLogin.html +++ b/docs/functions/attemptSilentLogin.html @@ -26,7 +26,7 @@

Function attemptSilentLogin

Returns RequestHandler

+
  • Defined in index.d.ts:968
  • +
  • Defined in index.d.ts:868
  • +
  • Defined in index.d.ts:948
  • +
  • Defined in index.d.ts:890
  • Returns boolean

    +
  • Defined in index.d.ts:816
  • token_type: string

    The type of access token, Usually "Bearer".

    +
  • Defined in index.d.ts:806
  • Methods

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

    Parameters

    Optional params: RefreshParams

    Returns Promise<AccessToken>

    +
  • Defined in index.d.ts:828
  • +
  • Defined in index.d.ts:256
  • +
  • Defined in index.d.ts:442
  • attemptSilentLogin?: boolean
    @@ -121,21 +121,21 @@
    +
  • Defined in index.d.ts:405
  • auth0Logout?: boolean

    Boolean value to enable idpLogout with an Auth0 custom domain

    +
  • Defined in index.d.ts:296
  • authRequired?: boolean

    Require authentication for all routes.

    +
  • Defined in index.d.ts:480
  • authorizationParams?: AuthorizationParameters
    @@ -152,7 +152,7 @@
    +
  • Defined in index.d.ts:343
  • baseURL?: string
    @@ -164,7 +164,7 @@
    +
  • Defined in index.d.ts:364
  • clientAssertionSigningAlg?: "RS256" | "RS384" | "RS512" | "PS256" | "PS384" | "PS512" | "ES256" | "ES256K" | "ES384" | "ES512" | "EdDSA"
    @@ -174,7 +174,7 @@
    +
  • Defined in index.d.ts:567
  • clientAssertionSigningKey?: KeyObject | KeyInput | JSONWebKey
    @@ -190,14 +190,14 @@
    +
  • Defined in index.d.ts:559
  • 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:517
  • clientID?: string
    @@ -205,7 +205,7 @@
    +
  • Defined in index.d.ts:370
  • clientSecret?: string
    @@ -214,7 +214,7 @@
    +
  • Defined in index.d.ts:377
  • clockTolerance?: number
    @@ -222,14 +222,14 @@
    +
  • Defined in index.d.ts:383
  • discoveryCacheMaxAge?: number

    Maximum time (in milliseconds) to wait before fetching the Identity Provider's Discovery document again. Default is 600000 (10 minutes).

    +
  • Defined in index.d.ts:588
  • enableTelemetry?: boolean
    @@ -237,7 +237,7 @@
    +
  • Defined in index.d.ts:389
  • errorOnRequiredAuth?: boolean
    @@ -245,7 +245,7 @@
    +
  • Defined in index.d.ts:395
  • getLoginState?: ((req: OpenidRequest, options: LoginOptions) => object)
    @@ -279,7 +279,7 @@
    req: LoginOptions

    Returns object

    +
  • Defined in index.d.ts:423
  • httpAgent?: {
        http?: false | Agent;
        http2?: unknown;
        https?: false | Agent;
    }
    @@ -299,28 +299,28 @@
    Optional http2
    Optional https?: false | Agent
    +
  • Defined in index.d.ts:605
  • httpTimeout?: number

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

    +
  • Defined in index.d.ts:593
  • httpUserAgent?: string

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

    +
  • Defined in index.d.ts:614
  • idTokenSigningAlg?: string

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

    +
  • Defined in index.d.ts:463
  • identityClaimFilter?: string[]
    @@ -328,14 +328,14 @@
    +
  • Defined in index.d.ts:453
  • idpLogout?: boolean

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

    +
  • Defined in index.d.ts:458
  • issuerBaseURL?: string
    @@ -343,7 +343,7 @@
    +
  • Defined in index.d.ts:469
  • legacySameSiteCookie?: boolean
    @@ -351,7 +351,7 @@
    +
  • Defined in index.d.ts:475
  • logoutParams?: {
        [key: string]: any;
    }
    @@ -363,7 +363,7 @@

    Type declaration

  • [key: string]: any
  • +
  • Defined in index.d.ts:348
  • routes?: {
        callback?: string | false;
        login?: string | false;
        logout?: string | false;
        postLogoutRedirect?: string;
    }
    @@ -391,7 +391,7 @@
    Optional postLogout The user will be redirected to this after a logout has been performed.

    +
  • Defined in index.d.ts:485
  • secret?: string | string[]
    @@ -403,28 +403,28 @@
    +
  • Defined in index.d.ts:286
  • Object defining application session cookie attributes.

    +
  • Defined in index.d.ts:291
  • 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:583
  • transactionCookie?: Pick<CookieConfigParams, "sameSite"> & {
        name?: string;
    }

    Configuration parameters used for the transaction cookie.

    +
  • Defined in index.d.ts:512
  • +
  • Defined in index.d.ts:779
  • path?: string
    @@ -61,7 +61,7 @@
    +
  • Defined in index.d.ts:766
  • sameSite?: string
    @@ -71,7 +71,7 @@
    +
  • Defined in index.d.ts:794
  • secure?: boolean
    @@ -80,7 +80,7 @@
    +
  • Defined in index.d.ts:786
  • transient?: boolean
    @@ -88,7 +88,7 @@
    +
  • Defined in index.d.ts:772
  • +
  • Defined in index.d.ts:228
  • +
  • Defined in index.d.ts:238
  • +
  • Defined in index.d.ts:96
  • idTokenClaims?: IdTokenClaims

    An object containing all the claims of the ID Token.

    +
  • Defined in index.d.ts:115
  • isAuthenticated: (() => boolean)
    @@ -84,7 +84,7 @@

    Type declaration

    Returns boolean

    +
  • Defined in index.d.ts:89
  • refreshToken?: string
    @@ -92,7 +92,7 @@
    +
  • Defined in index.d.ts:110
  • user?: Record<string, any>
    @@ -100,7 +100,7 @@
    +
  • Defined in index.d.ts:121
  • Methods

    @@ -114,7 +114,7 @@
    +
  • Defined in index.d.ts:136
  • +
  • Defined in index.d.ts:191
  • login: ((opts?: LoginOptions) => Promise<void>)
    @@ -85,7 +85,7 @@

    Parameters

    Optional opts: LoginOptions

    Returns Promise<void>

    +
  • Defined in index.d.ts:167
  • logout: ((opts?: LogoutOptions) => Promise<void>)
    @@ -108,7 +108,7 @@

    Parameters

    Optional opts: LogoutOptions

    Returns Promise<void>

    +
  • Defined in index.d.ts:179
  • +
  • Defined in index.d.ts:699
  • name?: string
    @@ -97,7 +97,7 @@
    +
  • Defined in index.d.ts:674
  • requireSignedSessionStoreCookie?: boolean
    @@ -112,7 +112,7 @@
    +
  • Defined in index.d.ts:723
  • rolling?: boolean
    @@ -123,7 +123,7 @@
    +
  • Defined in index.d.ts:732
  • rollingDuration?: number
    @@ -132,7 +132,7 @@
    +
  • Defined in index.d.ts:739
  • signSessionStoreCookie?: boolean
    @@ -142,7 +142,7 @@
    +
  • Defined in index.d.ts:708
  • store?: SessionStore
    @@ -153,7 +153,7 @@
    +
  • Defined in index.d.ts:683
  • Returns void

    +
  • Defined in index.d.ts:643
  • Returns void

    +
  • Defined in index.d.ts:651
  • +
  • Defined in index.d.ts:618