@timum/booking 0.7.5 → 0.8.1

package/README.md

@@ -23,19 +23,28 @@
 
 <a name=”features”></a>
 
+## Introduction
+
+timum BookingJs is a fully customizable appointment booking frontend app, intended to be integrated into every web page or web app or mobile app. It is ready to use out-of-the-box. And it provides the ability to customize it.
+This documentation guides you through all the customization capabilities.
+
 ## Features
 
-- Direct booking or appointment requests for public appointments
-- Approval required for requested appointments
-- Option to show/hide fully booked appointments
-- Option to prevent booking if appointment is too close to current time
-- Customer ability to cancel appointments with proper authentication
-- Customizable wording across languages
-- Support for multiple languages (English and German included)
-- Callbacks for custom code execution and event response (e.g. booking created, appointments loaded, booking canceled)
-- Customizable look and feel with mui theming (available with professional plan)
-- Dynamic definition of input fields with localized labels and validation
+- Real time availability and booking
+- Booking requests for public appointments - approval required
+- Multiple participant appointments
+- Visitor ligitimation - only invited visitors see the booking widget on public pages, listings, exposés
+- Visitor identification - via customer ID from CRM
+- Show/hide fully booked appointments option
+- Prebooking period option - prevents booking if appointment is too soon from now
+- Double booking prevention
+- Cancelling appointment by customer with proper authentication
+- Fully customizable look and feel with mui theming (available with premium plans)
+- Customizable wording across languages (availabe with premium plans)
+- Dynamic definition of input fields with localized labels and validation (available with premium plans)
   - Therefore, ability to request additional information from customers during booking process
+- Support for multiple languages (English and German included) - add your own language
+- Callbacks for custom code execution and event response (e.g. booking created, appointments loaded, booking canceled)
 
 <a name=”basic_usage”></a>
 
@@ -50,7 +59,7 @@ Add the following code to your webpage:
 ```html
 <div id="bookingjs" style="margin: 32px"></div>
 <script type="module">
-  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.7.4/build/timum-booking.js';
+  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.8.0/build/timum-booking.js';
 
   timum.init({ ref: 'booking-widget-demo-resource@timum' });
 </script>
@@ -65,7 +74,7 @@ Alternatively, you can add `ref` to your url as a parameter. This allows you to
 ```html
 <div id="bookingjs" style="margin: 32px"></div>
 <script type="module">
-  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.7.4/build/timum-booking.js';
+  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.8.0/build/timum-booking.js';
 
   timum.init(); //<- no need for the reference here
 </script>
@@ -269,7 +278,9 @@ In order to display public appointments, resource and calendar information timum
       provider: {
         name: 'string',
         description: 'string',
-        isBrandingAllowed: 'boolean',
+        isThemingAllowed: 'boolean',
+        isLocalisationAllowed: 'boolean',
+        areCustomFieldsAllowed: 'boolean'
       },
       channel: {
         bookingProcess: 'string' // One of 'IMMEDIATE' or 'REQUESTED',
@@ -372,7 +383,7 @@ localization: {
         'Sie müssen die Datenschutzbestimmungen akzeptieren bevor Sie buchen können.',
       email_field_must_be_valid: 'Geben Sie eine valide E-Mail Adresse ein',
     },
-    fields: {
+    fields: { // field labels are markdown capable. That's why you can use basic html as well.
       firstName: 'Vorname',
       lastName: 'Nachname',
       name: 'Name',
@@ -380,7 +391,8 @@ localization: {
       mobile: 'Mobil',
       message: 'Ihre Nachricht',
       accept_timum_privacy:
-        'Datenschutzbestimmungen gelesen und akzeptiert',
+            '<a href="https://info.timum.de/datenschutz" target="_blank">Datenschutzbestimmungen</a> gelesen und akzeptiert',
+
     },
   },
   // the same for english.
@@ -422,14 +434,16 @@ localization: {
         'You must accept the privacy policy prior to booking.',
       email_field_must_be_valid: 'Enter a valid email address',
     },
-    fields: {
+    fields: { // field labels are markdown capable. That's why you can use basic html as well.
       firstName: 'First name',
       lastName: 'Last name',
       name: 'name',
       email: 'E-mail',
       mobile: 'Mobile',
       message: 'Your Message',
-      accept_timum_privacy: '<0>Privacy policy</0> read and accepted.',
+      accept_timum_privacy:
+            '<a href="https://info.timum.de/datenschutz" target="_blank">Privacy policy</a> read and accepted.',
+
     },
   },
 },
@@ -439,7 +453,7 @@ localization: {
 
 #### How to define fields
 
-You can customize the information required from customers before booking by defining fields. The minimum required fields for timum are firstName, lastName, email, and agbs. By default, timum also requests mobile and message fields, but you can add your own fields as well.
+You can customize the information you request from customers before booking by defining fields. The minimum required fields for timum are firstName, lastName, email, and agbs. By default, timum also requests mobile and message fields, but you can add your own fields as well.
 
 Fields, including custom ones, support validation and localization.
 Validation is realized using the yup library, which is included with timum. You can import it using the following code:
@@ -539,16 +553,14 @@ Type `select`:
 
 ### An Example
 
-Here is an example Tying all of the aforementioned concepts together.
+Here is an example tying all of the aforementioned concepts together.
+And [here](https://jsfiddle.net/timum/wov6pLk7/) is a fiddle containing the very example detailed in this chapter.
 
 <a name=”the_scenario”></a>
 
 #### The Scenario
 
-For whatever reason it is important to know the gender of customers.
-On the other side the optional fields `mobile` and `message` aren't important for you and you wish to remove them.
-This new gender field must be filled, therefore a validation is required.
-Both the title of the field and it's validations must be localized.
+It is necessary to determine the gender of customers for a specific purpose. The `mobile` and `message` fields are not necessary and will be removed. The new `gender` field must be filled, therefore a validation check is required to ensure it is completed. Both the name of the `gender` field and the validation messages must be translated into different languages.
 
 <a name=”the_implementation”></a>
 
@@ -559,7 +571,7 @@ This is the base configuration. As it is it uses the standard field configuratio
 ```html
 <div id="bookingjs" style="margin: 32px"></div>
 <script type="module">
-  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.7.4/build/timum-booking.js';
+  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.8.0/build/timum-booking.js';
 
   timum.init({ ref: 'booking-widget-demo-resource@timum' });
 </script>
@@ -570,7 +582,7 @@ Let's add the necessary changes:
 ```html
 <div id="bookingjs" style="margin: 32px"></div>
 <script type="module">
-  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.7.4/build/timum-booking.js';
+  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@0.8.0/build/timum-booking.js';
 
   timum.init(
   {

package/build/{index-2bb2e2b0.js → index-0480e070.js}

@@ -1,4 +1,4 @@
-import { r as b, s as f, u as m, v as F, w as d, _ as C, x as l, y as n, z as T, A as v, C as x } from "./index-e0658644.js";
+import { r as b, s as f, u as m, v as F, w as d, _ as C, x as l, y as n, z as T, A as v, C as x } from "./index-553c5952.js";
 function y(o) {
   return b("MuiTableFooter", o);
 }

package/build/{index-79756a4f.js → index-1b10e9aa.js}

@@ -1,4 +1,4 @@
-import { c as e, e as a, d as l } from "./index-e0658644.js";
+import { c as e, e as a, d as l } from "./index-553c5952.js";
 export {
   e as default,
   a as getListItemTextUtilityClass,

package/build/{index-c9f18310.js → index-404c5e68.js}

@@ -1,4 +1,4 @@
-import { o as e, q as s, p as t } from "./index-e0658644.js";
+import { o as e, q as s, p as t } from "./index-553c5952.js";
 export {
   e as default,
   s as getTableCellUtilityClass,

package/build/{index-d3c08546.js → index-43f4920d.js}

@@ -1,4 +1,4 @@
-import { L as l, a as t, l as e } from "./index-e0658644.js";
+import { L as l, a as t, l as e } from "./index-553c5952.js";
 export {
   l as default,
   t as getLinkUtilityClass,