@wix/redirects 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/headless-v1-redirect-session.http.d.ts +8 -6
- package/build/cjs/src/headless-v1-redirect-session.http.js +8 -6
- package/build/cjs/src/headless-v1-redirect-session.http.js.map +1 -1
- package/build/cjs/src/headless-v1-redirect-session.types.d.ts +17 -13
- package/build/cjs/src/headless-v1-redirect-session.types.js.map +1 -1
- package/build/cjs/src/headless-v1-redirect-session.universal.d.ts +30 -20
- package/build/cjs/src/headless-v1-redirect-session.universal.js +8 -6
- package/build/cjs/src/headless-v1-redirect-session.universal.js.map +1 -1
- package/build/es/src/headless-v1-redirect-session.http.d.ts +8 -6
- package/build/es/src/headless-v1-redirect-session.http.js +8 -6
- package/build/es/src/headless-v1-redirect-session.http.js.map +1 -1
- package/build/es/src/headless-v1-redirect-session.types.d.ts +17 -13
- package/build/es/src/headless-v1-redirect-session.types.js.map +1 -1
- package/build/es/src/headless-v1-redirect-session.universal.d.ts +30 -20
- package/build/es/src/headless-v1-redirect-session.universal.js +8 -6
- package/build/es/src/headless-v1-redirect-session.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
2
|
import { CreateRedirectSessionRequest, CreateRedirectSessionResponse } from './headless-v1-redirect-session.types';
|
|
3
3
|
/**
|
|
4
|
-
* Creates a URL for redirecting a visitor
|
|
4
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
5
5
|
*
|
|
6
6
|
*
|
|
7
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
8
|
-
*
|
|
7
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
8
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
* the user back to the appropriate page on your site.
|
|
10
|
+
* To initiate a redirect session:
|
|
12
11
|
*
|
|
13
|
-
*
|
|
12
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
13
|
+
* the user back to your site as appropriate when the process is over.
|
|
14
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
15
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
14
16
|
*/
|
|
15
17
|
export declare function createRedirectSession(payload: CreateRedirectSessionRequest): RequestOptionsFactory<CreateRedirectSessionResponse>;
|
|
@@ -23,16 +23,18 @@ function resolveWixHeadlessV1RedirectSessionServiceUrl(opts) {
|
|
|
23
23
|
return (0, metro_runtime_1.resolveUrl)(Object.assign(opts, { domainToMappings }));
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* Creates a URL for redirecting a visitor
|
|
26
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
27
27
|
*
|
|
28
28
|
*
|
|
29
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
30
|
-
*
|
|
29
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
30
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
31
31
|
*
|
|
32
|
-
*
|
|
33
|
-
* the user back to the appropriate page on your site.
|
|
32
|
+
* To initiate a redirect session:
|
|
34
33
|
*
|
|
35
|
-
*
|
|
34
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
35
|
+
* the user back to your site as appropriate when the process is over.
|
|
36
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
37
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
36
38
|
*/
|
|
37
39
|
function createRedirectSession(payload) {
|
|
38
40
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createRedirectSessionRequest, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"headless-v1-redirect-session.http.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"headless-v1-redirect-session.http.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CACnC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,6BAA6B,EAC7B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IAE7E,SAAS,uBAAuB,CAAC,EAAE,IAAI,EAAO;QAC5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,kCAAkC;YAC9C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,uBAAuB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1C,OAAO,uBAAuB,CAAC;AACjC,CAAC;AA9BD,sDA8BC"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
/** Information for redirecting a visitor
|
|
1
|
+
/** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
|
|
2
2
|
export interface RedirectSession {
|
|
3
3
|
/** ID of the redirect session created. */
|
|
4
4
|
id?: string;
|
|
5
5
|
/**
|
|
6
|
-
* The full URL of the Wix page to redirect the visitor
|
|
6
|
+
* The full URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
|
|
7
7
|
* @readonly
|
|
8
8
|
*/
|
|
9
9
|
fullUrl?: string;
|
|
@@ -23,7 +23,11 @@ export interface CreateRedirectSessionRequest extends CreateRedirectSessionReque
|
|
|
23
23
|
logout?: RedirectSessionLogoutParams;
|
|
24
24
|
/** Information required for generating a custom URL for Wix authentication. */
|
|
25
25
|
auth?: RedirectSessionAuthParams;
|
|
26
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* Details of pages to redirect the visitor back to on the Wix Headless client site.
|
|
28
|
+
*
|
|
29
|
+
* **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
30
|
+
*/
|
|
27
31
|
callbacks?: CallbackParams;
|
|
28
32
|
/** Optional preferences for customizing redirection to Wix pages. */
|
|
29
33
|
preferences?: RedirectSessionPreferences;
|
|
@@ -46,7 +50,7 @@ export interface CreateRedirectSessionRequestIntentOneOf {
|
|
|
46
50
|
auth?: RedirectSessionAuthParams;
|
|
47
51
|
}
|
|
48
52
|
export interface RedirectSessionBookingsCheckoutParams {
|
|
49
|
-
/** The timezone to use when presenting the selected slot to users
|
|
53
|
+
/** The timezone to use when presenting the selected slot to users, in [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`. */
|
|
50
54
|
timezone?: string;
|
|
51
55
|
/** *Required.** ID of the service for which to select the slot. Use [Query Services](https://dev.wix.com/api/rest/wix-bookings/services-v2/query-services) to obtain a service ID. */
|
|
52
56
|
serviceId?: string;
|
|
@@ -192,8 +196,8 @@ export interface RedirectSessionPaidPlansCheckoutParams {
|
|
|
192
196
|
/** *Required.** ID of the paid plan selected. Use [Query Public Plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/query-public-plans) to obtain a paid plan ID. */
|
|
193
197
|
planId?: string;
|
|
194
198
|
/**
|
|
195
|
-
* For use when pricing plan selection is part of a checkout flow
|
|
196
|
-
* In this case, a string is
|
|
199
|
+
* For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
|
|
200
|
+
* In this case, a string is received by the external pricing plans page as a `checkoutData` query parameter. Pass this string back here when redirecting back to Wix for checkout.
|
|
197
201
|
*/
|
|
198
202
|
checkoutData?: string | null;
|
|
199
203
|
}
|
|
@@ -283,16 +287,16 @@ export declare enum MembersAccountSection {
|
|
|
283
287
|
}
|
|
284
288
|
export interface CallbackParams {
|
|
285
289
|
/**
|
|
286
|
-
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor
|
|
287
|
-
* If the process is abandoned or interrupted, the visitor
|
|
290
|
+
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor is directed to this page after the Wix-managed process is completed.
|
|
291
|
+
* If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
|
|
288
292
|
*
|
|
289
|
-
* Default: If you don't pass a URL, the visitor
|
|
293
|
+
* Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
|
|
290
294
|
*/
|
|
291
295
|
thankYouPageUrl?: string | null;
|
|
292
296
|
/**
|
|
293
|
-
* The URL Wix should redirect the visitor
|
|
297
|
+
* The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
|
|
294
298
|
*
|
|
295
|
-
* **Note**: For an authentication redirect,
|
|
299
|
+
* **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
296
300
|
*/
|
|
297
301
|
postFlowUrl?: string | null;
|
|
298
302
|
/**
|
|
@@ -322,7 +326,7 @@ export interface CallbackParams {
|
|
|
322
326
|
}
|
|
323
327
|
export interface RedirectSessionPreferences {
|
|
324
328
|
/**
|
|
325
|
-
* Whether to use a standard Wix template for Wix pages
|
|
329
|
+
* Whether to use a standard Wix template for Wix-managed pages the visitor is redirected to. Set to `false` only if your client site connects with a Wix site that has custom pages.
|
|
326
330
|
*
|
|
327
331
|
* Default: `true`
|
|
328
332
|
*/
|
|
@@ -335,7 +339,7 @@ export interface CustomMemberPaths {
|
|
|
335
339
|
profilePagePath?: string | null;
|
|
336
340
|
}
|
|
337
341
|
export interface CreateRedirectSessionResponse {
|
|
338
|
-
/** Details for redirecting the visitor
|
|
342
|
+
/** Details for redirecting the visitor to a Wix page. */
|
|
339
343
|
redirectSession?: RedirectSession;
|
|
340
344
|
}
|
|
341
345
|
export interface ValidateCallbackURLRequest {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":";;;AAyKA,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"}
|
|
@@ -4,12 +4,12 @@ export declare const __debug: {
|
|
|
4
4
|
off: () => boolean;
|
|
5
5
|
};
|
|
6
6
|
};
|
|
7
|
-
/** Information for redirecting a visitor
|
|
7
|
+
/** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
|
|
8
8
|
export interface RedirectSession {
|
|
9
9
|
/** ID of the redirect session created. */
|
|
10
10
|
_id?: string;
|
|
11
11
|
/**
|
|
12
|
-
* The full URL of the Wix page to redirect the visitor
|
|
12
|
+
* The full URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
|
|
13
13
|
* @readonly
|
|
14
14
|
*/
|
|
15
15
|
fullUrl?: string;
|
|
@@ -29,7 +29,11 @@ export interface CreateRedirectSessionRequest extends CreateRedirectSessionReque
|
|
|
29
29
|
logout?: RedirectSessionLogoutParams;
|
|
30
30
|
/** Information required for generating a custom URL for Wix authentication. */
|
|
31
31
|
auth?: RedirectSessionAuthParams;
|
|
32
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* Details of pages to redirect the visitor back to on the Wix Headless client site.
|
|
34
|
+
*
|
|
35
|
+
* **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
36
|
+
*/
|
|
33
37
|
callbacks?: CallbackParams;
|
|
34
38
|
/** Optional preferences for customizing redirection to Wix pages. */
|
|
35
39
|
preferences?: RedirectSessionPreferences;
|
|
@@ -52,7 +56,7 @@ export interface CreateRedirectSessionRequestIntentOneOf {
|
|
|
52
56
|
auth?: RedirectSessionAuthParams;
|
|
53
57
|
}
|
|
54
58
|
export interface RedirectSessionBookingsCheckoutParams {
|
|
55
|
-
/** The timezone to use when presenting the selected slot to users
|
|
59
|
+
/** The timezone to use when presenting the selected slot to users, in [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`. */
|
|
56
60
|
timezone?: string;
|
|
57
61
|
/** *Required.** ID of the service for which to select the slot. Use [Query Services](https://dev.wix.com/api/rest/wix-bookings/services-v2/query-services) to obtain a service ID. */
|
|
58
62
|
serviceId?: string;
|
|
@@ -198,8 +202,8 @@ export interface RedirectSessionPaidPlansCheckoutParams {
|
|
|
198
202
|
/** *Required.** ID of the paid plan selected. Use [Query Public Plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/query-public-plans) to obtain a paid plan ID. */
|
|
199
203
|
planId?: string;
|
|
200
204
|
/**
|
|
201
|
-
* For use when pricing plan selection is part of a checkout flow
|
|
202
|
-
* In this case, a string is
|
|
205
|
+
* For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
|
|
206
|
+
* In this case, a string is received by the external pricing plans page as a `checkoutData` query parameter. Pass this string back here when redirecting back to Wix for checkout.
|
|
203
207
|
*/
|
|
204
208
|
checkoutData?: string | null;
|
|
205
209
|
}
|
|
@@ -289,16 +293,16 @@ export declare enum MembersAccountSection {
|
|
|
289
293
|
}
|
|
290
294
|
export interface CallbackParams {
|
|
291
295
|
/**
|
|
292
|
-
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor
|
|
293
|
-
* If the process is abandoned or interrupted, the visitor
|
|
296
|
+
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor is directed to this page after the Wix-managed process is completed.
|
|
297
|
+
* If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
|
|
294
298
|
*
|
|
295
|
-
* Default: If you don't pass a URL, the visitor
|
|
299
|
+
* Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
|
|
296
300
|
*/
|
|
297
301
|
thankYouPageUrl?: string | null;
|
|
298
302
|
/**
|
|
299
|
-
* The URL Wix should redirect the visitor
|
|
303
|
+
* The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
|
|
300
304
|
*
|
|
301
|
-
* **Note**: For an authentication redirect,
|
|
305
|
+
* **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
302
306
|
*/
|
|
303
307
|
postFlowUrl?: string | null;
|
|
304
308
|
/**
|
|
@@ -328,7 +332,7 @@ export interface CallbackParams {
|
|
|
328
332
|
}
|
|
329
333
|
export interface RedirectSessionPreferences {
|
|
330
334
|
/**
|
|
331
|
-
* Whether to use a standard Wix template for Wix pages
|
|
335
|
+
* Whether to use a standard Wix template for Wix-managed pages the visitor is redirected to. Set to `false` only if your client site connects with a Wix site that has custom pages.
|
|
332
336
|
*
|
|
333
337
|
* Default: `true`
|
|
334
338
|
*/
|
|
@@ -341,7 +345,7 @@ export interface CustomMemberPaths {
|
|
|
341
345
|
profilePagePath?: string | null;
|
|
342
346
|
}
|
|
343
347
|
export interface CreateRedirectSessionResponse {
|
|
344
|
-
/** Details for redirecting the visitor
|
|
348
|
+
/** Details for redirecting the visitor to a Wix page. */
|
|
345
349
|
redirectSession?: RedirectSession;
|
|
346
350
|
}
|
|
347
351
|
export interface ValidateCallbackURLRequest {
|
|
@@ -375,16 +379,18 @@ export interface SignInURLResponse {
|
|
|
375
379
|
redirectSession?: RedirectSession;
|
|
376
380
|
}
|
|
377
381
|
/**
|
|
378
|
-
* Creates a URL for redirecting a visitor
|
|
382
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
379
383
|
*
|
|
380
384
|
*
|
|
381
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
382
|
-
*
|
|
385
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
386
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
383
387
|
*
|
|
384
|
-
*
|
|
385
|
-
* the user back to the appropriate page on your site.
|
|
388
|
+
* To initiate a redirect session:
|
|
386
389
|
*
|
|
387
|
-
*
|
|
390
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
391
|
+
* the user back to your site as appropriate when the process is over.
|
|
392
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
393
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
388
394
|
* @public
|
|
389
395
|
* @documentationMaturity preview
|
|
390
396
|
* @requiredField CreateRedirectSessionRequest
|
|
@@ -405,7 +411,11 @@ export interface CreateRedirectSessionOptions extends CreateRedirectSessionReque
|
|
|
405
411
|
logout?: RedirectSessionLogoutParams;
|
|
406
412
|
/** Information required for generating a custom URL for Wix authentication. */
|
|
407
413
|
auth?: RedirectSessionAuthParams;
|
|
408
|
-
/**
|
|
414
|
+
/**
|
|
415
|
+
* Details of pages to redirect the visitor back to on the Wix Headless client site.
|
|
416
|
+
*
|
|
417
|
+
* **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
418
|
+
*/
|
|
409
419
|
callbacks?: CallbackParams;
|
|
410
420
|
/** Optional preferences for customizing redirection to Wix pages. */
|
|
411
421
|
preferences?: RedirectSessionPreferences;
|
|
@@ -80,16 +80,18 @@ var CallbackType;
|
|
|
80
80
|
const _createRedirectSessionRequest = {};
|
|
81
81
|
const _createRedirectSessionResponse = {};
|
|
82
82
|
/**
|
|
83
|
-
* Creates a URL for redirecting a visitor
|
|
83
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
84
84
|
*
|
|
85
85
|
*
|
|
86
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
87
|
-
*
|
|
86
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
87
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
88
88
|
*
|
|
89
|
-
*
|
|
90
|
-
* the user back to the appropriate page on your site.
|
|
89
|
+
* To initiate a redirect session:
|
|
91
90
|
*
|
|
92
|
-
*
|
|
91
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
92
|
+
* the user back to your site as appropriate when the process is over.
|
|
93
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
94
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
93
95
|
* @public
|
|
94
96
|
* @documentationMaturity preview
|
|
95
97
|
* @requiredField CreateRedirectSessionRequest
|
|
@@ -1 +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;
|
|
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;AA2K5B,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"}
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
2
|
import { CreateRedirectSessionRequest, CreateRedirectSessionResponse } from './headless-v1-redirect-session.types';
|
|
3
3
|
/**
|
|
4
|
-
* Creates a URL for redirecting a visitor
|
|
4
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
5
5
|
*
|
|
6
6
|
*
|
|
7
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
8
|
-
*
|
|
7
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
8
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
* the user back to the appropriate page on your site.
|
|
10
|
+
* To initiate a redirect session:
|
|
12
11
|
*
|
|
13
|
-
*
|
|
12
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
13
|
+
* the user back to your site as appropriate when the process is over.
|
|
14
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
15
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
14
16
|
*/
|
|
15
17
|
export declare function createRedirectSession(payload: CreateRedirectSessionRequest): RequestOptionsFactory<CreateRedirectSessionResponse>;
|
|
@@ -20,16 +20,18 @@ function resolveWixHeadlessV1RedirectSessionServiceUrl(opts) {
|
|
|
20
20
|
return resolveUrl(Object.assign(opts, { domainToMappings }));
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Creates a URL for redirecting a visitor
|
|
23
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
24
24
|
*
|
|
25
25
|
*
|
|
26
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
27
|
-
*
|
|
26
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
27
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
28
28
|
*
|
|
29
|
-
*
|
|
30
|
-
* the user back to the appropriate page on your site.
|
|
29
|
+
* To initiate a redirect session:
|
|
31
30
|
*
|
|
32
|
-
*
|
|
31
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
32
|
+
* the user back to your site as appropriate when the process is over.
|
|
33
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
34
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
33
35
|
*/
|
|
34
36
|
export function createRedirectSession(payload) {
|
|
35
37
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_createRedirectSessionRequest, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"headless-v1-redirect-session.http.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAQhD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"headless-v1-redirect-session.http.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAQhD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,6BAA6B,EAC7B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IAE7E,SAAS,uBAAuB,CAAC,EAAE,IAAI,EAAO;QAC5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,kCAAkC;YAC9C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,uBAAuB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1C,OAAO,uBAAuB,CAAC;AACjC,CAAC"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
/** Information for redirecting a visitor
|
|
1
|
+
/** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
|
|
2
2
|
export interface RedirectSession {
|
|
3
3
|
/** ID of the redirect session created. */
|
|
4
4
|
id?: string;
|
|
5
5
|
/**
|
|
6
|
-
* The full URL of the Wix page to redirect the visitor
|
|
6
|
+
* The full URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
|
|
7
7
|
* @readonly
|
|
8
8
|
*/
|
|
9
9
|
fullUrl?: string;
|
|
@@ -23,7 +23,11 @@ export interface CreateRedirectSessionRequest extends CreateRedirectSessionReque
|
|
|
23
23
|
logout?: RedirectSessionLogoutParams;
|
|
24
24
|
/** Information required for generating a custom URL for Wix authentication. */
|
|
25
25
|
auth?: RedirectSessionAuthParams;
|
|
26
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* Details of pages to redirect the visitor back to on the Wix Headless client site.
|
|
28
|
+
*
|
|
29
|
+
* **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
30
|
+
*/
|
|
27
31
|
callbacks?: CallbackParams;
|
|
28
32
|
/** Optional preferences for customizing redirection to Wix pages. */
|
|
29
33
|
preferences?: RedirectSessionPreferences;
|
|
@@ -46,7 +50,7 @@ export interface CreateRedirectSessionRequestIntentOneOf {
|
|
|
46
50
|
auth?: RedirectSessionAuthParams;
|
|
47
51
|
}
|
|
48
52
|
export interface RedirectSessionBookingsCheckoutParams {
|
|
49
|
-
/** The timezone to use when presenting the selected slot to users
|
|
53
|
+
/** The timezone to use when presenting the selected slot to users, in [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`. */
|
|
50
54
|
timezone?: string;
|
|
51
55
|
/** *Required.** ID of the service for which to select the slot. Use [Query Services](https://dev.wix.com/api/rest/wix-bookings/services-v2/query-services) to obtain a service ID. */
|
|
52
56
|
serviceId?: string;
|
|
@@ -192,8 +196,8 @@ export interface RedirectSessionPaidPlansCheckoutParams {
|
|
|
192
196
|
/** *Required.** ID of the paid plan selected. Use [Query Public Plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/query-public-plans) to obtain a paid plan ID. */
|
|
193
197
|
planId?: string;
|
|
194
198
|
/**
|
|
195
|
-
* For use when pricing plan selection is part of a checkout flow
|
|
196
|
-
* In this case, a string is
|
|
199
|
+
* For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
|
|
200
|
+
* In this case, a string is received by the external pricing plans page as a `checkoutData` query parameter. Pass this string back here when redirecting back to Wix for checkout.
|
|
197
201
|
*/
|
|
198
202
|
checkoutData?: string | null;
|
|
199
203
|
}
|
|
@@ -283,16 +287,16 @@ export declare enum MembersAccountSection {
|
|
|
283
287
|
}
|
|
284
288
|
export interface CallbackParams {
|
|
285
289
|
/**
|
|
286
|
-
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor
|
|
287
|
-
* If the process is abandoned or interrupted, the visitor
|
|
290
|
+
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor is directed to this page after the Wix-managed process is completed.
|
|
291
|
+
* If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
|
|
288
292
|
*
|
|
289
|
-
* Default: If you don't pass a URL, the visitor
|
|
293
|
+
* Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
|
|
290
294
|
*/
|
|
291
295
|
thankYouPageUrl?: string | null;
|
|
292
296
|
/**
|
|
293
|
-
* The URL Wix should redirect the visitor
|
|
297
|
+
* The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
|
|
294
298
|
*
|
|
295
|
-
* **Note**: For an authentication redirect,
|
|
299
|
+
* **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
296
300
|
*/
|
|
297
301
|
postFlowUrl?: string | null;
|
|
298
302
|
/**
|
|
@@ -322,7 +326,7 @@ export interface CallbackParams {
|
|
|
322
326
|
}
|
|
323
327
|
export interface RedirectSessionPreferences {
|
|
324
328
|
/**
|
|
325
|
-
* Whether to use a standard Wix template for Wix pages
|
|
329
|
+
* Whether to use a standard Wix template for Wix-managed pages the visitor is redirected to. Set to `false` only if your client site connects with a Wix site that has custom pages.
|
|
326
330
|
*
|
|
327
331
|
* Default: `true`
|
|
328
332
|
*/
|
|
@@ -335,7 +339,7 @@ export interface CustomMemberPaths {
|
|
|
335
339
|
profilePagePath?: string | null;
|
|
336
340
|
}
|
|
337
341
|
export interface CreateRedirectSessionResponse {
|
|
338
|
-
/** Details for redirecting the visitor
|
|
342
|
+
/** Details for redirecting the visitor to a Wix page. */
|
|
339
343
|
redirectSession?: RedirectSession;
|
|
340
344
|
}
|
|
341
345
|
export interface ValidateCallbackURLRequest {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":"AAyKA,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"}
|
|
@@ -4,12 +4,12 @@ export declare const __debug: {
|
|
|
4
4
|
off: () => boolean;
|
|
5
5
|
};
|
|
6
6
|
};
|
|
7
|
-
/** Information for redirecting a visitor
|
|
7
|
+
/** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
|
|
8
8
|
export interface RedirectSession {
|
|
9
9
|
/** ID of the redirect session created. */
|
|
10
10
|
_id?: string;
|
|
11
11
|
/**
|
|
12
|
-
* The full URL of the Wix page to redirect the visitor
|
|
12
|
+
* The full URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
|
|
13
13
|
* @readonly
|
|
14
14
|
*/
|
|
15
15
|
fullUrl?: string;
|
|
@@ -29,7 +29,11 @@ export interface CreateRedirectSessionRequest extends CreateRedirectSessionReque
|
|
|
29
29
|
logout?: RedirectSessionLogoutParams;
|
|
30
30
|
/** Information required for generating a custom URL for Wix authentication. */
|
|
31
31
|
auth?: RedirectSessionAuthParams;
|
|
32
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* Details of pages to redirect the visitor back to on the Wix Headless client site.
|
|
34
|
+
*
|
|
35
|
+
* **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
36
|
+
*/
|
|
33
37
|
callbacks?: CallbackParams;
|
|
34
38
|
/** Optional preferences for customizing redirection to Wix pages. */
|
|
35
39
|
preferences?: RedirectSessionPreferences;
|
|
@@ -52,7 +56,7 @@ export interface CreateRedirectSessionRequestIntentOneOf {
|
|
|
52
56
|
auth?: RedirectSessionAuthParams;
|
|
53
57
|
}
|
|
54
58
|
export interface RedirectSessionBookingsCheckoutParams {
|
|
55
|
-
/** The timezone to use when presenting the selected slot to users
|
|
59
|
+
/** The timezone to use when presenting the selected slot to users, in [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`. */
|
|
56
60
|
timezone?: string;
|
|
57
61
|
/** *Required.** ID of the service for which to select the slot. Use [Query Services](https://dev.wix.com/api/rest/wix-bookings/services-v2/query-services) to obtain a service ID. */
|
|
58
62
|
serviceId?: string;
|
|
@@ -198,8 +202,8 @@ export interface RedirectSessionPaidPlansCheckoutParams {
|
|
|
198
202
|
/** *Required.** ID of the paid plan selected. Use [Query Public Plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/query-public-plans) to obtain a paid plan ID. */
|
|
199
203
|
planId?: string;
|
|
200
204
|
/**
|
|
201
|
-
* For use when pricing plan selection is part of a checkout flow
|
|
202
|
-
* In this case, a string is
|
|
205
|
+
* For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
|
|
206
|
+
* In this case, a string is received by the external pricing plans page as a `checkoutData` query parameter. Pass this string back here when redirecting back to Wix for checkout.
|
|
203
207
|
*/
|
|
204
208
|
checkoutData?: string | null;
|
|
205
209
|
}
|
|
@@ -289,16 +293,16 @@ export declare enum MembersAccountSection {
|
|
|
289
293
|
}
|
|
290
294
|
export interface CallbackParams {
|
|
291
295
|
/**
|
|
292
|
-
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor
|
|
293
|
-
* If the process is abandoned or interrupted, the visitor
|
|
296
|
+
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor is directed to this page after the Wix-managed process is completed.
|
|
297
|
+
* If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
|
|
294
298
|
*
|
|
295
|
-
* Default: If you don't pass a URL, the visitor
|
|
299
|
+
* Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
|
|
296
300
|
*/
|
|
297
301
|
thankYouPageUrl?: string | null;
|
|
298
302
|
/**
|
|
299
|
-
* The URL Wix should redirect the visitor
|
|
303
|
+
* The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
|
|
300
304
|
*
|
|
301
|
-
* **Note**: For an authentication redirect,
|
|
305
|
+
* **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
302
306
|
*/
|
|
303
307
|
postFlowUrl?: string | null;
|
|
304
308
|
/**
|
|
@@ -328,7 +332,7 @@ export interface CallbackParams {
|
|
|
328
332
|
}
|
|
329
333
|
export interface RedirectSessionPreferences {
|
|
330
334
|
/**
|
|
331
|
-
* Whether to use a standard Wix template for Wix pages
|
|
335
|
+
* Whether to use a standard Wix template for Wix-managed pages the visitor is redirected to. Set to `false` only if your client site connects with a Wix site that has custom pages.
|
|
332
336
|
*
|
|
333
337
|
* Default: `true`
|
|
334
338
|
*/
|
|
@@ -341,7 +345,7 @@ export interface CustomMemberPaths {
|
|
|
341
345
|
profilePagePath?: string | null;
|
|
342
346
|
}
|
|
343
347
|
export interface CreateRedirectSessionResponse {
|
|
344
|
-
/** Details for redirecting the visitor
|
|
348
|
+
/** Details for redirecting the visitor to a Wix page. */
|
|
345
349
|
redirectSession?: RedirectSession;
|
|
346
350
|
}
|
|
347
351
|
export interface ValidateCallbackURLRequest {
|
|
@@ -375,16 +379,18 @@ export interface SignInURLResponse {
|
|
|
375
379
|
redirectSession?: RedirectSession;
|
|
376
380
|
}
|
|
377
381
|
/**
|
|
378
|
-
* Creates a URL for redirecting a visitor
|
|
382
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
379
383
|
*
|
|
380
384
|
*
|
|
381
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
382
|
-
*
|
|
385
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
386
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
383
387
|
*
|
|
384
|
-
*
|
|
385
|
-
* the user back to the appropriate page on your site.
|
|
388
|
+
* To initiate a redirect session:
|
|
386
389
|
*
|
|
387
|
-
*
|
|
390
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
391
|
+
* the user back to your site as appropriate when the process is over.
|
|
392
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
393
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
388
394
|
* @public
|
|
389
395
|
* @documentationMaturity preview
|
|
390
396
|
* @requiredField CreateRedirectSessionRequest
|
|
@@ -405,7 +411,11 @@ export interface CreateRedirectSessionOptions extends CreateRedirectSessionReque
|
|
|
405
411
|
logout?: RedirectSessionLogoutParams;
|
|
406
412
|
/** Information required for generating a custom URL for Wix authentication. */
|
|
407
413
|
auth?: RedirectSessionAuthParams;
|
|
408
|
-
/**
|
|
414
|
+
/**
|
|
415
|
+
* Details of pages to redirect the visitor back to on the Wix Headless client site.
|
|
416
|
+
*
|
|
417
|
+
* **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
|
|
418
|
+
*/
|
|
409
419
|
callbacks?: CallbackParams;
|
|
410
420
|
/** Optional preferences for customizing redirection to Wix pages. */
|
|
411
421
|
preferences?: RedirectSessionPreferences;
|
|
@@ -58,16 +58,18 @@ export var CallbackType;
|
|
|
58
58
|
const _createRedirectSessionRequest = {};
|
|
59
59
|
const _createRedirectSessionResponse = {};
|
|
60
60
|
/**
|
|
61
|
-
* Creates a URL for redirecting a visitor
|
|
61
|
+
* Creates a URL for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality.
|
|
62
62
|
*
|
|
63
63
|
*
|
|
64
|
-
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to
|
|
65
|
-
*
|
|
64
|
+
* The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
|
|
65
|
+
* For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
|
|
66
66
|
*
|
|
67
|
-
*
|
|
68
|
-
* the user back to the appropriate page on your site.
|
|
67
|
+
* To initiate a redirect session:
|
|
69
68
|
*
|
|
70
|
-
*
|
|
69
|
+
* 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect
|
|
70
|
+
* the user back to your site as appropriate when the process is over.
|
|
71
|
+
* 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
|
|
72
|
+
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
71
73
|
* @public
|
|
72
74
|
* @documentationMaturity preview
|
|
73
75
|
* @requiredField CreateRedirectSessionRequest
|
|
@@ -1 +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;
|
|
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;AA2K5B,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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/redirects",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
"groupId": "com.wixpress.public-sdk-autogen"
|
|
34
34
|
}
|
|
35
35
|
},
|
|
36
|
-
"falconPackageHash": "
|
|
36
|
+
"falconPackageHash": "968b485f4920ddc9e69e8f3fe4c1d43d2ea74d26bb7ff0d6df535ec6"
|
|
37
37
|
}
|