@wix/bookings 1.0.1754 → 1.0.1756
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/_sdk-exports/context-booking-checkout/runtime.d.ts +791 -143
- package/_sdk-exports/context-booking-checkout/runtime.js +3 -2
- package/_sdk-exports/context-categories/runtime.d.ts +164 -2
- package/_sdk-exports/context-categories/runtime.js +2 -1
- package/_sdk-exports/context-locations/runtime.d.ts +186 -2
- package/_sdk-exports/context-locations/runtime.js +2 -1
- package/_sdk-exports/context-service/runtime.d.ts +1540 -144
- package/_sdk-exports/context-service/runtime.js +3 -2
- package/_sdk-exports/context-service-addons/runtime.d.ts +215 -13
- package/_sdk-exports/context-service-addons/runtime.js +2 -1
- package/_sdk-exports/context-services/runtime.d.ts +371 -77
- package/_sdk-exports/context-services/runtime.js +3 -2
- package/_sdk-exports/context-time-slots/runtime.d.ts +854 -72
- package/_sdk-exports/context-time-slots/runtime.js +3 -2
- package/build/cjs/context-booking-checkout.d.ts +791 -143
- package/build/cjs/context-booking-checkout.js +1759 -1640
- package/build/cjs/context-booking-checkout.js.map +1 -1
- package/build/cjs/context-categories.d.ts +164 -2
- package/build/cjs/context-categories.js +116 -114
- package/build/cjs/context-categories.js.map +1 -1
- package/build/cjs/context-locations.d.ts +186 -2
- package/build/cjs/context-locations.js +126 -124
- package/build/cjs/context-locations.js.map +1 -1
- package/build/cjs/context-service-addons.d.ts +215 -13
- package/build/cjs/context-service-addons.js +323 -321
- package/build/cjs/context-service-addons.js.map +1 -1
- package/build/cjs/context-service.d.ts +1540 -144
- package/build/cjs/context-service.js +1622 -1616
- package/build/cjs/context-service.js.map +1 -1
- package/build/cjs/context-services.d.ts +371 -77
- package/build/cjs/context-services.js +460 -458
- package/build/cjs/context-services.js.map +1 -1
- package/build/cjs/context-time-slots.d.ts +854 -72
- package/build/cjs/context-time-slots.js +1033 -1000
- package/build/cjs/context-time-slots.js.map +1 -1
- package/build/es/context-booking-checkout.d.mts +791 -143
- package/build/es/context-booking-checkout.mjs +1778 -1650
- package/build/es/context-booking-checkout.mjs.map +1 -1
- package/build/es/context-categories.d.mts +164 -2
- package/build/es/context-categories.mjs +116 -114
- package/build/es/context-categories.mjs.map +1 -1
- package/build/es/context-locations.d.mts +186 -2
- package/build/es/context-locations.mjs +126 -124
- package/build/es/context-locations.mjs.map +1 -1
- package/build/es/context-service-addons.d.mts +215 -13
- package/build/es/context-service-addons.mjs +323 -321
- package/build/es/context-service-addons.mjs.map +1 -1
- package/build/es/context-service.d.mts +1540 -144
- package/build/es/context-service.mjs +1622 -1616
- package/build/es/context-service.mjs.map +1 -1
- package/build/es/context-services.d.mts +371 -77
- package/build/es/context-services.mjs +460 -458
- package/build/es/context-services.mjs.map +1 -1
- package/build/es/context-time-slots.d.mts +854 -72
- package/build/es/context-time-slots.mjs +1033 -1000
- package/build/es/context-time-slots.mjs.map +1 -1
- package/build/internal/cjs/context-booking-checkout.d.ts +791 -143
- package/build/internal/cjs/context-categories.d.ts +164 -2
- package/build/internal/cjs/context-locations.d.ts +186 -2
- package/build/internal/cjs/context-service-addons.d.ts +215 -13
- package/build/internal/cjs/context-service.d.ts +1540 -144
- package/build/internal/cjs/context-services.d.ts +371 -77
- package/build/internal/cjs/context-time-slots.d.ts +854 -72
- package/build/internal/es/context-booking-checkout.d.mts +791 -143
- package/build/internal/es/context-categories.d.mts +164 -2
- package/build/internal/es/context-locations.d.mts +186 -2
- package/build/internal/es/context-service-addons.d.mts +215 -13
- package/build/internal/es/context-service.d.mts +1540 -144
- package/build/internal/es/context-services.d.mts +371 -77
- package/build/internal/es/context-time-slots.d.mts +854 -72
- package/package.json +5 -5
|
@@ -774,7 +774,7 @@ type Link = {
|
|
|
774
774
|
* You can use it to offer customers different prices for a service,
|
|
775
775
|
* depending on which choices they book.
|
|
776
776
|
*/
|
|
777
|
-
interface ServiceOptionsAndVariants
|
|
777
|
+
interface ServiceOptionsAndVariants {
|
|
778
778
|
/**
|
|
779
779
|
* ID of the `serviceOptionsAndVariants` object.
|
|
780
780
|
* @format GUID
|
|
@@ -857,6 +857,11 @@ declare enum ServiceOptionType {
|
|
|
857
857
|
* @documentationMaturity preview
|
|
858
858
|
*/
|
|
859
859
|
NUMBER_OF_PARTICIPANTS = "NUMBER_OF_PARTICIPANTS",
|
|
860
|
+
/**
|
|
861
|
+
* The price is resolved by the business location the service is booked at.
|
|
862
|
+
* @documentationMaturity preview
|
|
863
|
+
*/
|
|
864
|
+
LOCATION = "LOCATION",
|
|
860
865
|
/**
|
|
861
866
|
* The price is resolved from pricing tiers based on the booking duration range.
|
|
862
867
|
* @documentationMaturity preview
|
|
@@ -864,7 +869,7 @@ declare enum ServiceOptionType {
|
|
|
864
869
|
DURATION_RANGE = "DURATION_RANGE"
|
|
865
870
|
}
|
|
866
871
|
/** @enumType */
|
|
867
|
-
type ServiceOptionTypeWithLiterals = ServiceOptionType | 'UNKNOWN' | 'CUSTOM' | 'STAFF_MEMBER' | 'DURATION' | 'DATE_TIME' | 'NUMBER_OF_PARTICIPANTS' | 'DURATION_RANGE';
|
|
872
|
+
type ServiceOptionTypeWithLiterals = ServiceOptionType | 'UNKNOWN' | 'CUSTOM' | 'STAFF_MEMBER' | 'DURATION' | 'DATE_TIME' | 'NUMBER_OF_PARTICIPANTS' | 'LOCATION' | 'DURATION_RANGE';
|
|
868
873
|
interface CustomServiceOption {
|
|
869
874
|
/**
|
|
870
875
|
* Name of the service option. For example, `Age group`, `Location`, `Equipment`,
|
|
@@ -925,6 +930,14 @@ interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
|
925
930
|
dateTime?: DateTimeRule;
|
|
926
931
|
/** A rule resolving the price by the number of participants. Available only for `NUMBER_OF_PARTICIPANTS` options. */
|
|
927
932
|
participantRange?: ParticipantsRange;
|
|
933
|
+
/**
|
|
934
|
+
* ID of the business location the price applies to.
|
|
935
|
+
*
|
|
936
|
+
* Limited to business locations. Custom and customer locations aren't supported.
|
|
937
|
+
* Available only for `LOCATION` options.
|
|
938
|
+
* @format GUID
|
|
939
|
+
*/
|
|
940
|
+
businessLocationId?: string;
|
|
928
941
|
/**
|
|
929
942
|
* A duration range tier resolving the price by how long the booking is.
|
|
930
943
|
* Available only for `DURATION_RANGE` options.
|
|
@@ -956,6 +969,14 @@ interface ServiceChoiceChoiceOneOf {
|
|
|
956
969
|
dateTime?: DateTimeRule;
|
|
957
970
|
/** A rule resolving the price by the number of participants. Available only for `NUMBER_OF_PARTICIPANTS` options. */
|
|
958
971
|
participantRange?: ParticipantsRange;
|
|
972
|
+
/**
|
|
973
|
+
* ID of the business location the price applies to.
|
|
974
|
+
*
|
|
975
|
+
* Limited to business locations. Custom and customer locations aren't supported.
|
|
976
|
+
* Available only for `LOCATION` options.
|
|
977
|
+
* @format GUID
|
|
978
|
+
*/
|
|
979
|
+
businessLocationId?: string;
|
|
959
980
|
/**
|
|
960
981
|
* A duration range tier resolving the price by how long the booking is.
|
|
961
982
|
* Available only for `DURATION_RANGE` options.
|
|
@@ -1205,9 +1226,9 @@ interface ExtendedFields$1 {
|
|
|
1205
1226
|
namespaces?: Record<string, Record<string, any>>;
|
|
1206
1227
|
}
|
|
1207
1228
|
//#endregion
|
|
1208
|
-
//#region ../../node_modules/@wix/auto_sdk_bookings_services/build/es/bookings-services-v2-service-services.universal-
|
|
1229
|
+
//#region ../../node_modules/@wix/auto_sdk_bookings_services/build/es/bookings-services-v2-service-services.universal-p5eQUd5f.d.mts
|
|
1209
1230
|
/** The `service` object represents an offering that a business provides to its customers. */
|
|
1210
|
-
interface Service
|
|
1231
|
+
interface Service {
|
|
1211
1232
|
/**
|
|
1212
1233
|
* Service ID.
|
|
1213
1234
|
* @format GUID
|
|
@@ -1580,6 +1601,12 @@ interface FixedPayment {
|
|
|
1580
1601
|
* Default: `false`.
|
|
1581
1602
|
*/
|
|
1582
1603
|
fullUpfrontPaymentAllowed?: boolean | null;
|
|
1604
|
+
/**
|
|
1605
|
+
* The deposit required to book the service, expressed as either a fixed amount or a percentage of the price.
|
|
1606
|
+
*
|
|
1607
|
+
* Used only when `paymentOptions.deposit` is `true`.
|
|
1608
|
+
*/
|
|
1609
|
+
depositDetails?: DepositDetails;
|
|
1583
1610
|
}
|
|
1584
1611
|
/**
|
|
1585
1612
|
* Money.
|
|
@@ -1608,6 +1635,35 @@ interface Money {
|
|
|
1608
1635
|
* A deposit expressed as exactly one of a fixed monetary amount or a percentage of the full service price.
|
|
1609
1636
|
* Structurally exclusive: at most one of `amount` or `percentage` may be set.
|
|
1610
1637
|
*/
|
|
1638
|
+
interface DepositDetails extends DepositDetailsValueOneOf {
|
|
1639
|
+
/** The deposit as a fixed monetary amount. */
|
|
1640
|
+
amount?: Money;
|
|
1641
|
+
/**
|
|
1642
|
+
* The deposit as a percentage of the full service price, for example `20` for 20% or `20.5` for 20.5%.
|
|
1643
|
+
* Resolved to a concrete amount when the customer books.
|
|
1644
|
+
*
|
|
1645
|
+
* Min: `0.01` percent
|
|
1646
|
+
* Max: `99.99` percent
|
|
1647
|
+
* @format DECIMAL_VALUE
|
|
1648
|
+
* @decimalValue options { gte:0.01, lte:99.99, maxScale:2 }
|
|
1649
|
+
*/
|
|
1650
|
+
percentage?: string | null;
|
|
1651
|
+
}
|
|
1652
|
+
/** @oneof */
|
|
1653
|
+
interface DepositDetailsValueOneOf {
|
|
1654
|
+
/** The deposit as a fixed monetary amount. */
|
|
1655
|
+
amount?: Money;
|
|
1656
|
+
/**
|
|
1657
|
+
* The deposit as a percentage of the full service price, for example `20` for 20% or `20.5` for 20.5%.
|
|
1658
|
+
* Resolved to a concrete amount when the customer books.
|
|
1659
|
+
*
|
|
1660
|
+
* Min: `0.01` percent
|
|
1661
|
+
* Max: `99.99` percent
|
|
1662
|
+
* @format DECIMAL_VALUE
|
|
1663
|
+
* @decimalValue options { gte:0.01, lte:99.99, maxScale:2 }
|
|
1664
|
+
*/
|
|
1665
|
+
percentage?: string | null;
|
|
1666
|
+
}
|
|
1611
1667
|
interface CustomPayment {
|
|
1612
1668
|
/**
|
|
1613
1669
|
* A custom description explaining to the customer how to pay for the service.
|
|
@@ -1642,6 +1698,12 @@ interface VariedPayment {
|
|
|
1642
1698
|
* Default: `false`.
|
|
1643
1699
|
*/
|
|
1644
1700
|
fullUpfrontPaymentAllowed?: boolean | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* The deposit required to book the service, expressed as either a fixed amount or a percentage of the price.
|
|
1703
|
+
*
|
|
1704
|
+
* Used only when `paymentOptions.deposit` is `true`.
|
|
1705
|
+
*/
|
|
1706
|
+
depositDetails?: DepositDetails;
|
|
1645
1707
|
}
|
|
1646
1708
|
interface SubscriptionPayment {
|
|
1647
1709
|
/**
|
|
@@ -2251,6 +2313,7 @@ interface CancellationFeePolicy {
|
|
|
2251
2313
|
*/
|
|
2252
2314
|
autoCollectFeeEnabled?: boolean | null;
|
|
2253
2315
|
}
|
|
2316
|
+
/** What happens to the plan credit when the customer cancels a booking paid with a pricing plan. */
|
|
2254
2317
|
interface CancellationWindow extends CancellationWindowFeeOneOf {
|
|
2255
2318
|
/** Amount to be charged as a cancellation fee. */
|
|
2256
2319
|
amount?: Money;
|
|
@@ -2459,12 +2522,7 @@ interface DailyConfig {
|
|
|
2459
2522
|
*/
|
|
2460
2523
|
maxDurationInDays?: number;
|
|
2461
2524
|
}
|
|
2462
|
-
/**
|
|
2463
|
-
* Controls how a service's own working hours combine with the working hours of its assigned
|
|
2464
|
-
* staff members and required resources. The hours themselves are not held here. They are the
|
|
2465
|
-
* `WORKING_HOURS` events on the service's schedule (`schedule.id`), and this message controls
|
|
2466
|
-
* only how they combine with the resources working hours.
|
|
2467
|
-
*/
|
|
2525
|
+
/** Times of day at which each bookable day of a daily service starts and ends. */
|
|
2468
2526
|
interface StaffMember {
|
|
2469
2527
|
/**
|
|
2470
2528
|
* ID of the [resource](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction) associated with the staff member providing the service.
|
|
@@ -2486,6 +2544,14 @@ interface StaffMember {
|
|
|
2486
2544
|
* @readonly
|
|
2487
2545
|
*/
|
|
2488
2546
|
mainMedia?: StaffMediaItem;
|
|
2547
|
+
/**
|
|
2548
|
+
* Business locations where the staff member is available, based on their working hours.
|
|
2549
|
+
* Returned only when both `STAFF_MEMBER_DETAILS` and `STAFF_WORKING_HOURS_LOCATIONS` are passed in `conditionalFields`.
|
|
2550
|
+
* Can be omitted for a staff member who has no working hours. Treat a missing value the same as `availableAtAllLocations` set to `false` with an empty `locationIds`.
|
|
2551
|
+
* When the working hours data can't be retrieved, the entire request fails.
|
|
2552
|
+
* @readonly
|
|
2553
|
+
*/
|
|
2554
|
+
workingHoursLocationCoverage?: WorkingHoursLocationCoverage;
|
|
2489
2555
|
}
|
|
2490
2556
|
interface StaffMediaItem extends StaffMediaItemItemOneOf {
|
|
2491
2557
|
/** Details of the image associated with the staff, such as URL and size. */
|
|
@@ -2497,24 +2563,29 @@ interface StaffMediaItemItemOneOf {
|
|
|
2497
2563
|
image?: string;
|
|
2498
2564
|
}
|
|
2499
2565
|
/**
|
|
2500
|
-
*
|
|
2501
|
-
* (`NONE` and `MASTER` recurrence types). The server paginates through Calendar results
|
|
2502
|
-
* (100 events per page) until all matching events are collected.
|
|
2503
|
-
*
|
|
2504
|
-
* Coverage states when enrichment is requested:
|
|
2505
|
-
* + `available_at_all_locations = true`: Staff applies to every business location. Set when the staff
|
|
2506
|
-
* uses default business working hours, or has any WORKING_HOURS event without a location ID
|
|
2507
|
-
* (including when mixed with location-specific events).
|
|
2508
|
-
* + `available_at_all_locations = false` with non-empty `location_ids`: Staff has location-specific
|
|
2509
|
-
* WORKING_HOURS only. Show the staff member only when the selected location is in `location_ids`.
|
|
2510
|
-
* + `available_at_all_locations = false` with empty `location_ids`: Staff has working-hours schedules
|
|
2511
|
-
* but no applicable location coverage was found.
|
|
2512
|
-
*
|
|
2513
|
-
* Recommended client filter:
|
|
2514
|
-
* `availableAtAllLocations || locationIds.includes(selectedLocationId)`
|
|
2566
|
+
* Business locations where a staff member is available, based on their current and upcoming working hours.
|
|
2515
2567
|
*
|
|
2516
|
-
*
|
|
2568
|
+
* Coverage has 3 possible states:
|
|
2569
|
+
* + `availableAtAllLocations` is `true`: The staff member is available at every business location. This is the case when the staff member uses the business's default working hours, or when at least one of their working hours isn't limited to a specific location.
|
|
2570
|
+
* + `availableAtAllLocations` is `false` and `locationIds` isn't empty: The staff member is available at the business locations listed in `locationIds`.
|
|
2571
|
+
* + `availableAtAllLocations` is `false` and `locationIds` is empty: The staff member has no current or upcoming working hours, so they aren't available at any business location.
|
|
2572
|
+
* To check whether a staff member is available at a specific location, use `availableAtAllLocations || locationIds.includes(locationId)`.
|
|
2517
2573
|
*/
|
|
2574
|
+
interface WorkingHoursLocationCoverage {
|
|
2575
|
+
/**
|
|
2576
|
+
* Whether the staff member is available at every business location.
|
|
2577
|
+
* @readonly
|
|
2578
|
+
*/
|
|
2579
|
+
availableAtAllLocations?: boolean | null;
|
|
2580
|
+
/**
|
|
2581
|
+
* IDs of the business locations where the staff member has location-specific working hours.
|
|
2582
|
+
* Empty when `availableAtAllLocations` is `true`.
|
|
2583
|
+
* @format GUID
|
|
2584
|
+
* @readonly
|
|
2585
|
+
* @maxSize 100
|
|
2586
|
+
*/
|
|
2587
|
+
locationIds?: string[];
|
|
2588
|
+
}
|
|
2518
2589
|
interface StaffMemberDetails {
|
|
2519
2590
|
/**
|
|
2520
2591
|
* Staff members providing the service. For appointments only.
|
|
@@ -2614,73 +2685,117 @@ interface ExtendedFields {
|
|
|
2614
2685
|
namespaces?: Record<string, Record<string, any>>;
|
|
2615
2686
|
}
|
|
2616
2687
|
/**
|
|
2617
|
-
* The SEO
|
|
2618
|
-
*
|
|
2619
|
-
*
|
|
2688
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
2689
|
+
*
|
|
2690
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
2691
|
+
* field set must never change (see the file header). New writers use
|
|
2692
|
+
* `SeoSchemaV2`.
|
|
2693
|
+
*
|
|
2694
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
2695
|
+
* visible on the page itself. They override every other source of tags
|
|
2696
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
2620
2697
|
*/
|
|
2621
2698
|
interface SeoSchema {
|
|
2622
|
-
/**
|
|
2699
|
+
/**
|
|
2700
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
2701
|
+
* decided by the renderer, not by position in this list.
|
|
2702
|
+
*
|
|
2703
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
2704
|
+
* a bound added now could reject a page that is already stored.
|
|
2705
|
+
*/
|
|
2623
2706
|
tags?: Tag[];
|
|
2624
|
-
/** SEO
|
|
2707
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
2625
2708
|
settings?: Settings;
|
|
2626
2709
|
}
|
|
2710
|
+
/** A keyword term the user is targeting. */
|
|
2627
2711
|
interface Keyword {
|
|
2628
|
-
/**
|
|
2712
|
+
/**
|
|
2713
|
+
* The term itself, e.g. "trail running shoes".
|
|
2714
|
+
*
|
|
2715
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
2716
|
+
* already stored, and a bound added now could reject a record written
|
|
2717
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
2718
|
+
* on this field is accepted deliberately.
|
|
2719
|
+
*/
|
|
2629
2720
|
term?: string;
|
|
2630
|
-
/** Whether
|
|
2721
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
2631
2722
|
isMain?: boolean;
|
|
2632
2723
|
/**
|
|
2633
|
-
*
|
|
2724
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
2725
|
+
* attribution in BI. Opaque to the renderer.
|
|
2634
2726
|
* @maxLength 1000
|
|
2635
2727
|
*/
|
|
2636
2728
|
origin?: string | null;
|
|
2637
2729
|
}
|
|
2730
|
+
/**
|
|
2731
|
+
* One tag in the page's <head>.
|
|
2732
|
+
*
|
|
2733
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
2734
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
2735
|
+
* normalizes both shapes on READ.
|
|
2736
|
+
*/
|
|
2638
2737
|
interface Tag {
|
|
2639
2738
|
/**
|
|
2640
|
-
*
|
|
2641
|
-
*
|
|
2739
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
2740
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
2741
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
2642
2742
|
*
|
|
2643
|
-
*
|
|
2644
|
-
*
|
|
2645
|
-
*
|
|
2646
|
-
*
|
|
2647
|
-
*
|
|
2648
|
-
* `
|
|
2649
|
-
* check the field description of the specific `tags`-typed field you're writing to
|
|
2650
|
-
* for the types it actually supports and the error it returns.
|
|
2743
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
2744
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
2745
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
2746
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
2747
|
+
* error even though they appear here — check the field description of the
|
|
2748
|
+
* specific `tags`-typed field you are writing to.
|
|
2651
2749
|
*
|
|
2652
2750
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
2653
|
-
*
|
|
2654
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
2655
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
2656
|
-
* write through the site's Advanced/Custom Tags
|
|
2657
|
-
* omit `custom` (or set it to `false`).
|
|
2751
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
2752
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
2753
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
2754
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
2755
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
2756
|
+
*
|
|
2757
|
+
* No length limit: this field holds data written years ago by writers we
|
|
2758
|
+
* are not migrating. A constraint here could reject a record that is
|
|
2759
|
+
* already stored, which is exactly the promise this design makes.
|
|
2658
2760
|
*/
|
|
2659
2761
|
type?: string;
|
|
2660
2762
|
/**
|
|
2661
|
-
*
|
|
2662
|
-
*
|
|
2763
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
2764
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
2663
2765
|
*/
|
|
2664
2766
|
props?: Record<string, any> | null;
|
|
2665
|
-
/**
|
|
2767
|
+
/**
|
|
2768
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
2769
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
2770
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
2771
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
2772
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
2773
|
+
* page. See the design log for the full key-by-key mapping.
|
|
2774
|
+
*/
|
|
2666
2775
|
meta?: Record<string, any> | null;
|
|
2667
|
-
/**
|
|
2776
|
+
/**
|
|
2777
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
2778
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
2779
|
+
* `StructuredDataTag.json_ld`.
|
|
2780
|
+
* No length limit, for the same reason as `type` above.
|
|
2781
|
+
*/
|
|
2668
2782
|
children?: string;
|
|
2669
2783
|
/**
|
|
2670
2784
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
2671
2785
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
2672
2786
|
*
|
|
2673
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
2674
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
2675
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
2676
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
2677
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
2787
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
2788
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
2789
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
2790
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
2791
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
2678
2792
|
*
|
|
2679
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
2680
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
2681
|
-
* for site-wide structured data) unconditionally.
|
|
2682
|
-
* site-wide, every-page structured data
|
|
2683
|
-
* `script` tag through the Item
|
|
2793
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
2794
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
2795
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
2796
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
2797
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
2798
|
+
* SEO Tags API instead.
|
|
2684
2799
|
*
|
|
2685
2800
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
2686
2801
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -2693,22 +2808,39 @@ interface Tag {
|
|
|
2693
2808
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
2694
2809
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
2695
2810
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
2811
|
+
*
|
|
2812
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
2696
2813
|
*/
|
|
2697
2814
|
custom?: boolean;
|
|
2698
|
-
/**
|
|
2815
|
+
/**
|
|
2816
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
2817
|
+
*
|
|
2818
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
2819
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
2820
|
+
*/
|
|
2699
2821
|
disabled?: boolean;
|
|
2700
2822
|
}
|
|
2823
|
+
/** Page-level SEO settings that are not tags. */
|
|
2701
2824
|
interface Settings {
|
|
2702
2825
|
/**
|
|
2703
|
-
* Whether the
|
|
2826
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
2827
|
+
* its current one after a slug change.
|
|
2704
2828
|
*
|
|
2705
|
-
*
|
|
2706
|
-
*
|
|
2829
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
2830
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
2831
|
+
* renaming a stored boolean is not worth the migration.
|
|
2707
2832
|
*/
|
|
2708
2833
|
preventAutoRedirect?: boolean;
|
|
2709
2834
|
/**
|
|
2710
|
-
*
|
|
2711
|
-
*
|
|
2835
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
2836
|
+
* assistant and checklist; never rendered into <head>.
|
|
2837
|
+
*
|
|
2838
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
2839
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
2840
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
2841
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
2842
|
+
* something absurd.
|
|
2843
|
+
* @maxSize 20
|
|
2712
2844
|
*/
|
|
2713
2845
|
keywords?: Keyword[];
|
|
2714
2846
|
}
|
|
@@ -2777,19 +2909,36 @@ declare enum BasedOn {
|
|
|
2777
2909
|
type BasedOnWithLiterals = BasedOn | 'BUSINESS_TIME_ZONE' | 'CUSTOMER_TIME_ZONE';
|
|
2778
2910
|
//#endregion
|
|
2779
2911
|
//#region src/api/adapters/service/service.d.ts
|
|
2780
|
-
type Service = Service$1;
|
|
2781
2912
|
//#endregion
|
|
2782
2913
|
//#region src/api/adapters/service-options-and-variants/service-options-and-variants.d.ts
|
|
2783
|
-
type ServiceOptionsAndVariants = ServiceOptionsAndVariants$1;
|
|
2784
2914
|
//#endregion
|
|
2785
2915
|
//#region src/api/adapters/bookings-settings/bookings-settings.d.ts
|
|
2786
2916
|
/** A policy, not an IANA zone: the real zone needs the business zone from site properties. */
|
|
2787
2917
|
type DisplayTimeZonePolicy = {
|
|
2918
|
+
/**
|
|
2919
|
+
* Time zone the site shows times in by default.
|
|
2920
|
+
*
|
|
2921
|
+
* Supported values:
|
|
2922
|
+
* - `'BUSINESS_TIME_ZONE'`: The business's time zone.
|
|
2923
|
+
* - `'CUSTOMER_TIME_ZONE'`: The time zone of the visitor's browser.
|
|
2924
|
+
*/
|
|
2788
2925
|
basedOn: BasedOnWithLiterals;
|
|
2926
|
+
/**
|
|
2927
|
+
* Whether visitors can switch between the business's time zone and their own when they view
|
|
2928
|
+
* times.
|
|
2929
|
+
*/
|
|
2789
2930
|
customerCanChange: boolean;
|
|
2790
2931
|
};
|
|
2932
|
+
/**
|
|
2933
|
+
* The business's booking settings that affect how the site shows services and times.
|
|
2934
|
+
*
|
|
2935
|
+
* When loading the settings fails, holds the defaults: times in the business's time zone, which
|
|
2936
|
+
* visitors can't change, and multi-service appointments turned off.
|
|
2937
|
+
*/
|
|
2791
2938
|
interface ExposedBookingsSettings {
|
|
2939
|
+
/** Policy for the time zone the site shows times in. */
|
|
2792
2940
|
displayTimeZonePolicy: DisplayTimeZonePolicy;
|
|
2941
|
+
/** Whether visitors can book more than 1 service in a single appointment. */
|
|
2793
2942
|
multiServiceAppointmentsEnabled: boolean;
|
|
2794
2943
|
}
|
|
2795
2944
|
//#endregion
|
|
@@ -2806,30 +2955,168 @@ interface CategoriesPickerFilter {
|
|
|
2806
2955
|
//#region src/extensions/contexts/services-context/services-context.d.ts
|
|
2807
2956
|
/** Raw data only; the nested service-context derives display values. Not for direct binding. */
|
|
2808
2957
|
interface ServiceItem {
|
|
2958
|
+
/**
|
|
2959
|
+
* Service ID.
|
|
2960
|
+
*
|
|
2961
|
+
* `null` for the sample services shown in the editor.
|
|
2962
|
+
*/
|
|
2809
2963
|
serviceId: string | null;
|
|
2964
|
+
/**
|
|
2965
|
+
* Number that increases each time the services reload because a service changed while the site
|
|
2966
|
+
* is open in the editor.
|
|
2967
|
+
*
|
|
2968
|
+
* Always `0` on the live site.
|
|
2969
|
+
*/
|
|
2810
2970
|
refreshSignal: number;
|
|
2971
|
+
/**
|
|
2972
|
+
* The service, as the
|
|
2973
|
+
* [Services
|
|
2974
|
+
* API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction)
|
|
2975
|
+
* returns it.
|
|
2976
|
+
*/
|
|
2811
2977
|
service: Service;
|
|
2978
|
+
/**
|
|
2979
|
+
* Calendar events that define the sessions of a class or course, from today on: the events that
|
|
2980
|
+
* repeat on a schedule, and the sessions added one at a time. To get an event's details, use the
|
|
2981
|
+
* [Events
|
|
2982
|
+
* API](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction).
|
|
2983
|
+
*
|
|
2984
|
+
* Times are in the time zone that `bookingsSettings.displayTimeZonePolicy` sets.
|
|
2985
|
+
*
|
|
2986
|
+
* The events load after the service shows, so the array is empty until they arrive. Always empty
|
|
2987
|
+
* for an appointment or a service with no schedule, and when loading the events fails.
|
|
2988
|
+
*/
|
|
2812
2989
|
masterEvents: Event[];
|
|
2813
|
-
/**
|
|
2990
|
+
/**
|
|
2991
|
+
* Service's options and variants, which set the prices of its choices, as the [Service Options
|
|
2992
|
+
* and Variants
|
|
2993
|
+
* API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction)
|
|
2994
|
+
* returns them.
|
|
2995
|
+
*
|
|
2996
|
+
* `null` for a service without varied pricing, while they load, and when they fail to load. When
|
|
2997
|
+
* reloading them fails, it keeps the ones that loaded before.
|
|
2998
|
+
*/
|
|
2814
2999
|
serviceOptionsAndVariants: ServiceOptionsAndVariants | null;
|
|
3000
|
+
/** The business's booking settings. The same object as the context's `bookingsSettings`. */
|
|
2815
3001
|
bookingsSettings: ExposedBookingsSettings;
|
|
2816
3002
|
/**
|
|
2817
|
-
*
|
|
2818
|
-
*
|
|
2819
|
-
*
|
|
2820
|
-
*
|
|
3003
|
+
* Link to the service's page. Its `target` is `'_self'`, and its `href` follows the site's custom
|
|
3004
|
+
* URL structure for service pages, when the site has one.
|
|
3005
|
+
*
|
|
3006
|
+
* `null` when there's no link to build, such as when the site has no service page or the service
|
|
3007
|
+
* has no slug.
|
|
2821
3008
|
*/
|
|
2822
3009
|
servicePageLink: Link | null;
|
|
2823
3010
|
}
|
|
2824
3011
|
/** The loaded bookable services, with load-more paging and the category and location they are filtered by. */
|
|
2825
3012
|
interface ServicesContextValue {
|
|
3013
|
+
/**
|
|
3014
|
+
* Services loaded so far, with an item for each service.
|
|
3015
|
+
*
|
|
3016
|
+
* Holds only services that aren't hidden, filtered by `categoryId` and `locationId`, and limited
|
|
3017
|
+
* to the services and categories chosen in the list's settings. `loadMore()` adds the next page
|
|
3018
|
+
* of services to the end.
|
|
3019
|
+
*
|
|
3020
|
+
* Empty while the list loads or reloads, such as after `categoryId` or `locationId` changes, and
|
|
3021
|
+
* when `hasError` is `true`. In the editor, outside preview mode, a list that loads no services
|
|
3022
|
+
* holds sample services instead.
|
|
3023
|
+
*
|
|
3024
|
+
* Each item supplies the Service context of an item in the list, which works out the values to
|
|
3025
|
+
* show, such as the service's name and price. To show a service, call `useServiceContext()` from
|
|
3026
|
+
* `@wix/bookings/context/service` in a component inside a list item, rather than reading the
|
|
3027
|
+
* item's fields.
|
|
3028
|
+
*/
|
|
2826
3029
|
serviceItems: ServiceItem[];
|
|
3030
|
+
/**
|
|
3031
|
+
* The business's booking settings that affect how the site shows services and times.
|
|
3032
|
+
*
|
|
3033
|
+
* `null` while the context loads for the first time, and when `hasError` is `true` because of an
|
|
3034
|
+
* unexpected error. Check for `null` before you read it.
|
|
3035
|
+
*/
|
|
2827
3036
|
bookingsSettings: ExposedBookingsSettings | null;
|
|
3037
|
+
/**
|
|
3038
|
+
* Whether more services are available to load with `loadMore()`.
|
|
3039
|
+
*
|
|
3040
|
+
* `false` while the list loads or reloads, and when `hasError` is `true`.
|
|
3041
|
+
*/
|
|
2828
3042
|
hasMore: boolean;
|
|
3043
|
+
/**
|
|
3044
|
+
* Whether services are loading.
|
|
3045
|
+
*
|
|
3046
|
+
* `true` while the list loads or reloads, such as after `categoryId` or `locationId` changes, and
|
|
3047
|
+
* while `loadMore()` loads the next page. While the list loads or reloads, `serviceItems` is
|
|
3048
|
+
* empty.
|
|
3049
|
+
* While `loadMore()` loads a page, `serviceItems` keeps the services already loaded.
|
|
3050
|
+
*/
|
|
2829
3051
|
isLoading: boolean;
|
|
3052
|
+
/**
|
|
3053
|
+
* Whether the services failed to load.
|
|
3054
|
+
*
|
|
3055
|
+
* When `true`, `serviceItems` is empty. A failed `loadMore()` call doesn't set it.
|
|
3056
|
+
*/
|
|
2830
3057
|
hasError: boolean;
|
|
3058
|
+
/**
|
|
3059
|
+
* ID of the category that the list filters services by. To get the category's details, use the
|
|
3060
|
+
* [Categories
|
|
3061
|
+
* API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/categories-v2/introduction).
|
|
3062
|
+
*
|
|
3063
|
+
* Inside an item of a categories list, it's that item's category. Otherwise, it's the category in
|
|
3064
|
+
* the page URL's `category` query parameter.
|
|
3065
|
+
*
|
|
3066
|
+
* `null` when the services aren't filtered by category.
|
|
3067
|
+
*/
|
|
2831
3068
|
categoryId: string | null;
|
|
3069
|
+
/**
|
|
3070
|
+
* ID of the business location that the list filters services by, from the page URL's `location`
|
|
3071
|
+
* query parameter. To get the location's details, use the
|
|
3072
|
+
* [Locations
|
|
3073
|
+
* API](https://dev.wix.com/docs/api-reference/business-management/locations/introduction).
|
|
3074
|
+
*
|
|
3075
|
+
* `'OTHER_LOCATIONS'` stands for every location that isn't a business location, so the list holds
|
|
3076
|
+
* the services offered at a custom address or at the customer's place.
|
|
3077
|
+
*
|
|
3078
|
+
* `null` when the services aren't filtered by location.
|
|
3079
|
+
*/
|
|
2832
3080
|
locationId: string | null;
|
|
3081
|
+
/**
|
|
3082
|
+
* Loads the next page of services and adds them to the end of `serviceItems`.
|
|
3083
|
+
*
|
|
3084
|
+
* A page holds the number of services set in the list's settings, up to 100. `isLoading` is
|
|
3085
|
+
* `true` while the page loads. The page's calendar events load after the page is added, so each
|
|
3086
|
+
* new item's `masterEvents` fills in later.
|
|
3087
|
+
*
|
|
3088
|
+
* `loadMore()` doesn't load a page when:
|
|
3089
|
+
* - No more services are left to load. The promise resolves right away.
|
|
3090
|
+
* - A page is already loading. The call returns the promise of the page that's loading.
|
|
3091
|
+
*
|
|
3092
|
+
* When the list reloads while a page loads, such as after `categoryId` or `locationId` changes,
|
|
3093
|
+
* `loadMore()` discards the page.
|
|
3094
|
+
*
|
|
3095
|
+
* Never rejects. When the page fails to load, `serviceItems` and `hasMore` don't change, so
|
|
3096
|
+
* calling `loadMore()` again retries the same page.
|
|
3097
|
+
*
|
|
3098
|
+
* @returns Promise that resolves when the call ends: after `serviceItems` includes the new page,
|
|
3099
|
+
* after the page fails to load, or right away when there's no page to load.
|
|
3100
|
+
*
|
|
3101
|
+
* @example Add a load-more button
|
|
3102
|
+
* ```tsx
|
|
3103
|
+
* import { useServicesContext } from '@wix/bookings/context/services';
|
|
3104
|
+
*
|
|
3105
|
+
* function LoadMoreButton() {
|
|
3106
|
+
* const { hasMore, isLoading, loadMore } = useServicesContext();
|
|
3107
|
+
*
|
|
3108
|
+
* if (!hasMore) {
|
|
3109
|
+
* return null;
|
|
3110
|
+
* }
|
|
3111
|
+
*
|
|
3112
|
+
* return (
|
|
3113
|
+
* <button disabled={isLoading} onClick={() => loadMore()}>
|
|
3114
|
+
* {isLoading ? 'Loading...' : 'Load more'}
|
|
3115
|
+
* </button>
|
|
3116
|
+
* );
|
|
3117
|
+
* }
|
|
3118
|
+
* ```
|
|
3119
|
+
*/
|
|
2833
3120
|
loadMore: () => Promise<void>;
|
|
2834
3121
|
}
|
|
2835
3122
|
interface ServicesPickerFilter {
|
|
@@ -2848,7 +3135,14 @@ interface ServicesContextProviderProps {
|
|
|
2848
3135
|
}
|
|
2849
3136
|
declare const servicesContext: React.Context<ServicesContextValue | null>;
|
|
2850
3137
|
declare const SERVICES_CONTEXT_MISSING_PROVIDER_ERROR = "useServicesContext must be used within ServicesContextProvider";
|
|
2851
|
-
/**
|
|
3138
|
+
/**
|
|
3139
|
+
* The `useServicesContext()` hook provides access to a paged list of Wix Bookings services, such as
|
|
3140
|
+
* appointments, classes, and courses, filtered by category and location. Use it to show a list of
|
|
3141
|
+
* services and its loading, error, and empty states, and to load more services when the visitor
|
|
3142
|
+
* asks for them.
|
|
3143
|
+
*
|
|
3144
|
+
* It throws an error where the context isn't available.
|
|
3145
|
+
*/
|
|
2852
3146
|
declare function useServicesContext(): ServicesContextValue;
|
|
2853
3147
|
/** Loads a paged list of bookable services, filtered by the category and location in the page URL or a category-list item, and narrowed by the service and category pickers. */
|
|
2854
3148
|
declare function ServicesContextProvider({
|