@timum/booking 1.2.8 → 1.3.2

package/README.md

@@ -47,9 +47,9 @@ This documentation guides you through all the customization capabilities.
 - 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)
+- Fully customizable look and feel with mui theming (available with professional plans)
+- Customizable wording across languages (availabe with professional plans)
+- Dynamic definition of input fields with localized labels and validation (available with professional 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)
@@ -67,7 +67,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@1.2.8/build/timum-booking.js';
+  import * as timum from 'https://cdn.timum.de/bookingjs/booking.js';
 
   timum.init({ ref: 'booking-widget-demo-resource@timum' });
 </script>
@@ -82,7 +82,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@1.2.8/build/timum-booking.js';
+  import * as timum from 'https://cdn.timum.de/bookingjs/booking.js';
 
   timum.init(); //<- no need for the reference here
 </script>
@@ -92,7 +92,7 @@ Alternatively, you can add `ref` to your url as a parameter. This allows you to
 
 ### As ESM import
 
-1. Add timum-booking to your project with
+1. Add timum booking to your project with
    `yarn add @timum/booking`
    or use npm with
    `npm install @timum/booking`
@@ -212,7 +212,7 @@ See [here](https://mui.com/) for a general overview. <br> See [here](https://mui
 
 When you open the file `config.js` in [this](https://stackblitz.com/edit/react-8q6r8b?file=src/index.js) example, you can find an elaborate custom configuration which includes a redesign of the standard timum theme.
 
-Needs premium plan.
+Needs professional plan.
 
 <a name=”fc_config”></a>
 
@@ -223,6 +223,29 @@ See [here](https://fullcalendar.io/docs#toc) for a full list of configuration op
 
 > Note that since fullCalendar isn't mui based, it does not consider the muiTheme object.
 
+There are also some options specific to bookingjs. In addition to the configuration options of fullcalendar the following options are also available (all of them are optional):
+
+<table>
+   <tr>
+      <th>Property</th>
+      <th>Description</th>
+   </tr>
+   <tr>
+      <td>largeView</td>
+      <td>string, Determines which <code>view</code> is displayed for screen widths <i>greater</i> 601px. <br>Please refer to the fullcalendar docs linked above for an overview of applicable values. </td>
+   </tr>
+   <tr>
+      <td>smallView</td>
+      <td>string, Determines which <code>view</code> is displayed for screen widths <i>smaller</i> 601px. <br> Please refer to the fullcalendar docs linked above for an overview of applicable values. 
+   </td>
+   </tr>
+   <tr>
+      <td>useCustomTimumCss</td>
+      <td>boolean, to increase responsiveness, timum overrides some fullcalendar css classes. Set this to <code>false</code> to gain total control over fullcalendar's css.
+   </td>
+   </tr>
+</table>
+
 <a name=”app_config”></a>
 
 ### appConfig
@@ -238,6 +261,25 @@ This object's options directly affect timum's behaviour or allow you to react to
       <td>ref</td>
       <td>string, Reference of the resource to show the appointments of. <br><em> This is the only prop that is mandatory.</em><br> Everything else is optional. <br>Can also be a url parameter.</td>
    </tr>
+   <tr>
+      <td>platform</td>
+      <td>string, A fully qualified reference (<code>id@someUuid@platform</code>) can be unwieldy especially if used as a url param. This prop allows you to hardcode the <code>platform</code> part.
+      <br><br>Note that this prop is ignored if <code>ref</code> is both:
+      <ul>
+        <li>used as a url param </li>
+        <li>contains an @.</li>
+      </ul>  
+   </td>
+   </tr>
+   <tr>
+      <td>prvUuid</td>
+      <td>string, A fully qualified reference (<code>id@someUuid@platform</code>) can be unwieldy especially if used as a url param. This prop allows you to hardcode the <code>someUuid</code> part. This part is only sometimes necessary to uniquely identify a resource in timum. <br><br>Note that this prop is ignored if <code>ref</code> is both:
+      <ul>
+        <li>used as a url param </li>
+        <li>contains an @.</li>
+      </ul>  
+   </td>
+   </tr>
    <tr>
       <td>height</td>
       <td>  string, Height of timum on your page. `500px` is standard.</td>
@@ -248,7 +290,7 @@ This object's options directly affect timum's behaviour or allow you to react to
    </tr>
     <tr>
       <td>hideTimumFooter</td>
-      <td>boolean, whether 'powered by timum' can be hidden or not. Needs premium plan.</td>
+      <td>boolean, whether 'powered by timum' can be hidden or not. Needs professional plan.</td>
    </tr>
     <tr>
       <td>sendCustomValuesInMessage</td>
@@ -290,14 +332,14 @@ This object's options directly affect timum's behaviour or allow you to react to
       <td>fields</td>
       <td>object, You can customise what information is demanded of your customers prior to booking. timum requires certain fields to work and has some optional fields it can parse. Fields other than those supported by timum can be evaluated in a callback (see the callback guide below for further info). All fields (yours too!) support localization and input validation. 
       <br>
-      Needs premium plan. 
+      Needs professional plan. 
       </td>
    </tr>
    <tr>
       <td>localization</td>
       <td>object. Contains all localization variables and their standard texts. timum nativly supports English and German. Use this to override the standard text and/or add translations for your custom field labels and input validations (see the localisation guide for mor info.)
       <br>
-      Needs premium plan. 
+      Needs professional plan. 
       </td>
    </tr>
 </table>
@@ -628,7 +670,7 @@ The standard configuration can be overridden except for the aforementioned field
 
 If the values retrieved via custom fields need to be transferred to timum backend as additional booking information, set the parameter `sendCustomValuesInMessage`. With this, the values of custom fields are attached to the customer message. They will be visible to the customer as well in booking confirmation mailings.
 
-  `sendCustomValuesInMessage: true, // necessary to transmit custom field values as part of the customer message`
+`sendCustomValuesInMessage: true, // necessary to transmit custom field values as part of the customer message`
 
 Anatomy of a custom booking form field:
 
@@ -649,7 +691,7 @@ Anatomy of a custom booking form field:
 
 fieldName
 
-  - define a field name
+- define a field name
 
 Depending on the type there are additional properties you can/must specify:
 
@@ -697,7 +739,7 @@ This is the base configuration. As it uses the standard field configuration show
 ```html
 <div id="bookingjs" style="margin: 32px"></div>
 <script type="module">
-  import * as timum from 'https://cdn.jsdelivr.net/npm/@timum/booking@1.2.8/build/timum-booking.js';
+  import * as timum from 'https://cdn.timum.de/bookingjs/1/booking.js';
 
   timum.init({ ref: 'booking-widget-demo-resource@timum' });
 </script>
@@ -708,10 +750,9 @@ 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@1.2.8/build/timum-booking.js';
+  import * as timum from 'https://cdn.timum.de/bookingjs/1/booking.js';
 
-  timum.init(
-  {
+  timum.init({
     ref: 'booking-widget-demo-resource@timum',
 
     fields: {
@@ -722,12 +763,12 @@ Let's add the necessary changes:
         // index defines the order in which the fields get displayed
         index: 0,
         title: 'fields.firstName',
-        validation: yup.string().required('validation.field_required'), // <- compare with key in localisation
+        validation: yup.string().required('validation.field_required') // <- compare with key in localisation
       },
       lastName: {
         index: 1,
         title: 'fields.lastName',
-        validation: yup.string().required('validation.field_required'),
+        validation: yup.string().required('validation.field_required')
       },
       email: {
         index: 2,
@@ -737,7 +778,7 @@ Let's add the necessary changes:
         validation: yup
           .string()
           .email('validation.email_field_must_be_valid')
-          .required('validation.field_required'),
+          .required('validation.field_required')
       },
       gender: {
         index: 3,
@@ -751,8 +792,8 @@ Let's add the necessary changes:
         options: [
           { key: 'm', title: 'fields.gender.male' },
           { key: 'w', title: 'fields.gender.female' },
-          { key: 'd', title: 'fields.gender.other' },
-        ],
+          { key: 'd', title: 'fields.gender.other' }
+        ]
       },
       agbs: {
         index: 4,
@@ -765,8 +806,8 @@ Let's add the necessary changes:
             'privacyAccepted',
             'validation.privacy_field_required',
             (value) => value === true
-          ),
-      },
+          )
+      }
     },
     sendCustomValuesInMessage: true, // necessary to transmit custom field values as part of the customer message
 
@@ -783,20 +824,20 @@ Let's add the necessary changes:
             male: 'Männlich',
             female: 'Weiblich',
             other: 'Divers'
-          },
+          }
         }
       },
       en: {
-          validation: {
+        validation: {
           gender_field_required: 'Please select an option.'
         },
-          fields: {
-            gender: {
-              title: 'Gender',
-              male: 'Male',
-              female: 'Female',
-              other: 'Others'
-            },
+        fields: {
+          gender: {
+            title: 'Gender',
+            male: 'Male',
+            female: 'Female',
+            other: 'Others'
+          }
         }
       }
     },
@@ -804,7 +845,7 @@ Let's add the necessary changes:
     // the following callback consumes the customers input, allowing you to act on
     //the entered gender value.
     callback: {
-      createBookingStarted: ({data}) => {
+      createBookingStarted: ({ data }) => {
         console.log(data.gender);
       }
     }

package/build/{timum-booking.js → booking.js}

@@ -1,4 +1,4 @@
-import { R as s, H as o, J as t, G as e, I as m } from "./index-6afb67dd.js";
+import { R as s, H as o, J as t, G as e, I as m } from "./index-82388012.js";
 export {
   s as React,
   o as TimumBooking,