@wix/redirects 1.0.9 → 1.0.11

package/build/cjs/src/headless-v1-redirect-session.types.d.ts

@@ -217,49 +217,56 @@ export interface RedirectSessionAuthorizeParams {
  * the authorization process.
  */
 export interface AuthorizeRequest {
-    /** client_id is the unique identifier of the client application. */
+    /** ID of the Wix OAuth app requesting authorization. */
     clientId?: string;
     /**
-     * response_type specifies the desired authorization grant type.
-     * This can be "code" for the authorization code.
+     * Desired authorization [grant type](https://auth0.com/docs/authenticate/protocols/oauth#grant-types).
+     *
+     * Supported values:
+     * + `code`: The endpoint returns an authorization code that can be used to obtain an access token.
      */
     responseType?: string;
-    /**
-     * redirect_uri is the URI to which the authorization server will redirect the
-     * user-agent after the user grants/denies permission.
-     */
+    /** URI to redirect the browser to after authentication and authorization. The browser is redirected to this URI whether the authentication and authorization process is successful or not. */
     redirectUri?: string | null;
     /**
-     * scope is a space-delimited string that specifies the requested scope of the
-     * access request.
+     * Desired scope of access. If this field is left empty, only an access token is granted.
+     * To received a refresh token, pass `offline_access` as the value of this field.
      */
     scope?: string | null;
     /**
-     * An opaque value, used for security purposes. If this request parameter is set
-     * in the request, then it is returned to the application as part of the redirect_uri.
+     * A value used to confirm the state of an application before and after it makes an authorization
+     * request. If a value for this field is set in the request, it's added to the `redirectUri` when the browser
+     * is redirected there.
+     * Learn more about [using the state parameter](https://auth0.com/docs/secure/attack-protection/state-parameters).
      */
     state?: string;
-    /** (Optional) How the result of the authorization request is formatted */
+    /**
+     * esired response format.
+     *
+     * Supported values:
+     * + `query`: The response parameters are encoded as query string parameters and added to the `redirectUri` when redirecting.
+     * + `fragment`: The response parameters are encoded as URI fragment parameters and added to the `redirectUri` when redirecting.
+     * + `web_message`: The response parameters are encoded as a JSON object and added to the body of a [web message response](https://datatracker.ietf.org/doc/html/draft-sakimura-oauth-wmrm-00).
+     *
+     * Default value: `query`
+     */
     responseMode?: string | null;
     /**
-     * code_challenge is the code challenge sent by the client as part of the PKCE
-     * process. This field is only used if response_type is "code".
+     * Code challenge to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
      */
     codeChallenge?: string | null;
     /**
-     * code_challenge_method is the code challenge method sent by the client as part
-     * of the PKCE process. This field is only used if response_type is "code".
+     * Code challenge method to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
+     *
+     * Supported values:
+     * + `S256`: The code challenge is transformed using SHA-256 encyption.
+     * + `S512`: The code challenge is transformed using SHA-512 encyption.
      */
     codeChallengeMethod?: string | null;
-    /** Current client session */
+    /** Session token of the site visitor to authorize. */
     sessionToken?: string | null;
-    /**
-     * Optional fields for errors
-     * A short error code that describes the type of error that occurred (e.g. "invalid_request")
-     */
-    error?: string | null;
-    /** A human-readable description of the error that occurred */
-    errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
     /** *Required.** ID of the OAuth app authorizing the client. */

package/build/cjs/src/headless-v1-redirect-session.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":";;;AA6KA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAyHD,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAWhC;AAwED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB"}
+{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":";;;AA6KA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAgID,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAWhC;AAwED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB"}

package/build/cjs/src/headless-v1-redirect-session.universal.d.ts

@@ -223,49 +223,56 @@ export interface RedirectSessionAuthorizeParams {
  * the authorization process.
  */
 export interface AuthorizeRequest {
-    /** client_id is the unique identifier of the client application. */
+    /** ID of the Wix OAuth app requesting authorization. */
     clientId?: string;
     /**
-     * response_type specifies the desired authorization grant type.
-     * This can be "code" for the authorization code.
+     * Desired authorization [grant type](https://auth0.com/docs/authenticate/protocols/oauth#grant-types).
+     *
+     * Supported values:
+     * + `code`: The endpoint returns an authorization code that can be used to obtain an access token.
      */
     responseType?: string;
-    /**
-     * redirect_uri is the URI to which the authorization server will redirect the
-     * user-agent after the user grants/denies permission.
-     */
+    /** URI to redirect the browser to after authentication and authorization. The browser is redirected to this URI whether the authentication and authorization process is successful or not. */
     redirectUri?: string | null;
     /**
-     * scope is a space-delimited string that specifies the requested scope of the
-     * access request.
+     * Desired scope of access. If this field is left empty, only an access token is granted.
+     * To received a refresh token, pass `offline_access` as the value of this field.
      */
     scope?: string | null;
     /**
-     * An opaque value, used for security purposes. If this request parameter is set
-     * in the request, then it is returned to the application as part of the redirect_uri.
+     * A value used to confirm the state of an application before and after it makes an authorization
+     * request. If a value for this field is set in the request, it's added to the `redirectUri` when the browser
+     * is redirected there.
+     * Learn more about [using the state parameter](https://auth0.com/docs/secure/attack-protection/state-parameters).
      */
     state?: string;
-    /** (Optional) How the result of the authorization request is formatted */
+    /**
+     * esired response format.
+     *
+     * Supported values:
+     * + `query`: The response parameters are encoded as query string parameters and added to the `redirectUri` when redirecting.
+     * + `fragment`: The response parameters are encoded as URI fragment parameters and added to the `redirectUri` when redirecting.
+     * + `web_message`: The response parameters are encoded as a JSON object and added to the body of a [web message response](https://datatracker.ietf.org/doc/html/draft-sakimura-oauth-wmrm-00).
+     *
+     * Default value: `query`
+     */
     responseMode?: string | null;
     /**
-     * code_challenge is the code challenge sent by the client as part of the PKCE
-     * process. This field is only used if response_type is "code".
+     * Code challenge to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
      */
     codeChallenge?: string | null;
     /**
-     * code_challenge_method is the code challenge method sent by the client as part
-     * of the PKCE process. This field is only used if response_type is "code".
+     * Code challenge method to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
+     *
+     * Supported values:
+     * + `S256`: The code challenge is transformed using SHA-256 encyption.
+     * + `S512`: The code challenge is transformed using SHA-512 encyption.
      */
     codeChallengeMethod?: string | null;
-    /** Current client session */
+    /** Session token of the site visitor to authorize. */
     sessionToken?: string | null;
-    /**
-     * Optional fields for errors
-     * A short error code that describes the type of error that occurred (e.g. "invalid_request")
-     */
-    error?: string | null;
-    /** A human-readable description of the error that occurred */
-    errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
     /** __Required.__ ID of the OAuth app authorizing the client. */
@@ -306,7 +313,7 @@ export interface CallbackParams {
     /**
      * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
      *
-     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
      */
     postFlowUrl?: string | null;
     /**

package/build/cjs/src/headless-v1-redirect-session.universal.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session.universal.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,4GAA8F;AAE9F,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA+K5B,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAyHD,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAWhC;AAwED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB;AAiBD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,qBAAqB,CACzC,OAAsC;;;QAEtC,MAAM,qBAAqB,GAAG;YAC5B,gBAAgB,EAAE,uBAAuB;YACzC,YAAY,EAAE,mBAAmB;YACjC,cAAc,EAAE,qBAAqB;YACrC,iBAAiB,EAAE,wBAAwB;YAC3C,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gBAAgB;YAC3B,WAAW,EAAE,kBAAkB;SAChC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,8BAA8B;YAC1C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GACX,sCAAsC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,iDAAiD,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE7E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA/DD,sDA+DC"}
+{"version":3,"file":"headless-v1-redirect-session.universal.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,4GAA8F;AAE9F,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA+K5B,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAgID,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAWhC;AAwED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB;AAiBD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,qBAAqB,CACzC,OAAsC;;;QAEtC,MAAM,qBAAqB,GAAG;YAC5B,gBAAgB,EAAE,uBAAuB;YACzC,YAAY,EAAE,mBAAmB;YACjC,cAAc,EAAE,qBAAqB;YACrC,iBAAiB,EAAE,wBAAwB;YAC3C,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gBAAgB;YAC3B,WAAW,EAAE,kBAAkB;SAChC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,8BAA8B;YAC1C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GACX,sCAAsC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,iDAAiD,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE7E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA/DD,sDA+DC"}

package/build/es/src/headless-v1-redirect-session.types.d.ts

@@ -217,49 +217,56 @@ export interface RedirectSessionAuthorizeParams {
  * the authorization process.
  */
 export interface AuthorizeRequest {
-    /** client_id is the unique identifier of the client application. */
+    /** ID of the Wix OAuth app requesting authorization. */
     clientId?: string;
     /**
-     * response_type specifies the desired authorization grant type.
-     * This can be "code" for the authorization code.
+     * Desired authorization [grant type](https://auth0.com/docs/authenticate/protocols/oauth#grant-types).
+     *
+     * Supported values:
+     * + `code`: The endpoint returns an authorization code that can be used to obtain an access token.
      */
     responseType?: string;
-    /**
-     * redirect_uri is the URI to which the authorization server will redirect the
-     * user-agent after the user grants/denies permission.
-     */
+    /** URI to redirect the browser to after authentication and authorization. The browser is redirected to this URI whether the authentication and authorization process is successful or not. */
     redirectUri?: string | null;
     /**
-     * scope is a space-delimited string that specifies the requested scope of the
-     * access request.
+     * Desired scope of access. If this field is left empty, only an access token is granted.
+     * To received a refresh token, pass `offline_access` as the value of this field.
      */
     scope?: string | null;
     /**
-     * An opaque value, used for security purposes. If this request parameter is set
-     * in the request, then it is returned to the application as part of the redirect_uri.
+     * A value used to confirm the state of an application before and after it makes an authorization
+     * request. If a value for this field is set in the request, it's added to the `redirectUri` when the browser
+     * is redirected there.
+     * Learn more about [using the state parameter](https://auth0.com/docs/secure/attack-protection/state-parameters).
      */
     state?: string;
-    /** (Optional) How the result of the authorization request is formatted */
+    /**
+     * esired response format.
+     *
+     * Supported values:
+     * + `query`: The response parameters are encoded as query string parameters and added to the `redirectUri` when redirecting.
+     * + `fragment`: The response parameters are encoded as URI fragment parameters and added to the `redirectUri` when redirecting.
+     * + `web_message`: The response parameters are encoded as a JSON object and added to the body of a [web message response](https://datatracker.ietf.org/doc/html/draft-sakimura-oauth-wmrm-00).
+     *
+     * Default value: `query`
+     */
     responseMode?: string | null;
     /**
-     * code_challenge is the code challenge sent by the client as part of the PKCE
-     * process. This field is only used if response_type is "code".
+     * Code challenge to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
      */
     codeChallenge?: string | null;
     /**
-     * code_challenge_method is the code challenge method sent by the client as part
-     * of the PKCE process. This field is only used if response_type is "code".
+     * Code challenge method to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
+     *
+     * Supported values:
+     * + `S256`: The code challenge is transformed using SHA-256 encyption.
+     * + `S512`: The code challenge is transformed using SHA-512 encyption.
      */
     codeChallengeMethod?: string | null;
-    /** Current client session */
+    /** Session token of the site visitor to authorize. */
     sessionToken?: string | null;
-    /**
-     * Optional fields for errors
-     * A short error code that describes the type of error that occurred (e.g. "invalid_request")
-     */
-    error?: string | null;
-    /** A human-readable description of the error that occurred */
-    errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
     /** *Required.** ID of the OAuth app authorizing the client. */

package/build/es/src/headless-v1-redirect-session.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":"AA6KA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAyHD,MAAM,CAAN,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,KAArB,qBAAqB,QAWhC;AAwED,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB"}
+{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":"AA6KA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAgID,MAAM,CAAN,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,KAArB,qBAAqB,QAWhC;AAwED,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB"}

package/build/es/src/headless-v1-redirect-session.universal.d.ts

@@ -223,49 +223,56 @@ export interface RedirectSessionAuthorizeParams {
  * the authorization process.
  */
 export interface AuthorizeRequest {
-    /** client_id is the unique identifier of the client application. */
+    /** ID of the Wix OAuth app requesting authorization. */
     clientId?: string;
     /**
-     * response_type specifies the desired authorization grant type.
-     * This can be "code" for the authorization code.
+     * Desired authorization [grant type](https://auth0.com/docs/authenticate/protocols/oauth#grant-types).
+     *
+     * Supported values:
+     * + `code`: The endpoint returns an authorization code that can be used to obtain an access token.
      */
     responseType?: string;
-    /**
-     * redirect_uri is the URI to which the authorization server will redirect the
-     * user-agent after the user grants/denies permission.
-     */
+    /** URI to redirect the browser to after authentication and authorization. The browser is redirected to this URI whether the authentication and authorization process is successful or not. */
     redirectUri?: string | null;
     /**
-     * scope is a space-delimited string that specifies the requested scope of the
-     * access request.
+     * Desired scope of access. If this field is left empty, only an access token is granted.
+     * To received a refresh token, pass `offline_access` as the value of this field.
      */
     scope?: string | null;
     /**
-     * An opaque value, used for security purposes. If this request parameter is set
-     * in the request, then it is returned to the application as part of the redirect_uri.
+     * A value used to confirm the state of an application before and after it makes an authorization
+     * request. If a value for this field is set in the request, it's added to the `redirectUri` when the browser
+     * is redirected there.
+     * Learn more about [using the state parameter](https://auth0.com/docs/secure/attack-protection/state-parameters).
      */
     state?: string;
-    /** (Optional) How the result of the authorization request is formatted */
+    /**
+     * esired response format.
+     *
+     * Supported values:
+     * + `query`: The response parameters are encoded as query string parameters and added to the `redirectUri` when redirecting.
+     * + `fragment`: The response parameters are encoded as URI fragment parameters and added to the `redirectUri` when redirecting.
+     * + `web_message`: The response parameters are encoded as a JSON object and added to the body of a [web message response](https://datatracker.ietf.org/doc/html/draft-sakimura-oauth-wmrm-00).
+     *
+     * Default value: `query`
+     */
     responseMode?: string | null;
     /**
-     * code_challenge is the code challenge sent by the client as part of the PKCE
-     * process. This field is only used if response_type is "code".
+     * Code challenge to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
      */
     codeChallenge?: string | null;
     /**
-     * code_challenge_method is the code challenge method sent by the client as part
-     * of the PKCE process. This field is only used if response_type is "code".
+     * Code challenge method to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
+     *
+     * Supported values:
+     * + `S256`: The code challenge is transformed using SHA-256 encyption.
+     * + `S512`: The code challenge is transformed using SHA-512 encyption.
      */
     codeChallengeMethod?: string | null;
-    /** Current client session */
+    /** Session token of the site visitor to authorize. */
     sessionToken?: string | null;
-    /**
-     * Optional fields for errors
-     * A short error code that describes the type of error that occurred (e.g. "invalid_request")
-     */
-    error?: string | null;
-    /** A human-readable description of the error that occurred */
-    errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
     /** __Required.__ ID of the OAuth app authorizing the client. */
@@ -306,7 +313,7 @@ export interface CallbackParams {
     /**
      * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
      *
-     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
      */
     postFlowUrl?: string | null;
     /**

package/build/es/src/headless-v1-redirect-session.universal.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session.universal.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,sCAAsC,MAAM,qCAAqC,CAAC;AAE9F,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA+K5B,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAyHD,MAAM,CAAN,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,KAArB,qBAAqB,QAWhC;AAwED,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAiBD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAgB,qBAAqB,CACzC,OAAsC;;;QAEtC,MAAM,qBAAqB,GAAG;YAC5B,gBAAgB,EAAE,uBAAuB;YACzC,YAAY,EAAE,mBAAmB;YACjC,cAAc,EAAE,qBAAqB;YACrC,iBAAiB,EAAE,wBAAwB;YAC3C,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gBAAgB;YAC3B,WAAW,EAAE,kBAAkB;SAChC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,8BAA8B;YAC1C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GACX,sCAAsC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,iDAAiD,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE7E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF"}
+{"version":3,"file":"headless-v1-redirect-session.universal.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,sCAAsC,MAAM,qCAAqC,CAAC;AAE9F,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA+K5B,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAgID,MAAM,CAAN,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,KAArB,qBAAqB,QAWhC;AAwED,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAiBD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAgB,qBAAqB,CACzC,OAAsC;;;QAEtC,MAAM,qBAAqB,GAAG;YAC5B,gBAAgB,EAAE,uBAAuB;YACzC,YAAY,EAAE,mBAAmB;YACjC,cAAc,EAAE,qBAAqB;YACrC,iBAAiB,EAAE,wBAAwB;YAC3C,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gBAAgB;YAC3B,WAAW,EAAE,kBAAkB;SAChC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,8BAA8B;YAC1C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GACX,sCAAsC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,iDAAiD,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE7E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/redirects",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -33,5 +33,5 @@
       "groupId": "com.wixpress.public-sdk-autogen"
     }
   },
-  "falconPackageHash": "a27c46dd3de5ca06f2fa2268e94af8b0918bd377028e5034a9e2abf4"
+  "falconPackageHash": "4dd2575f9a5925d290d276054adb2076cbcfa5f571dae72b2f137069"
 }