feat: add advanced tab attributes to api/v2/event-types

[lizard-boy]

Overview

1. This PR introduces the advancedTab attribute to the following updated endpoints:

   Event Types:

   • [POST] /v2/event-types
   • [PATCH] /v2/event-types/{eventTypeId}
   • [GET] /v2/event-types/{eventTypeId} — now includes additional attributes.

   Organizations Event Types:

   • [POST] /v2/organizations/{orgId}/teams/{teamId}/event-types
   • [PATCH] /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}
   • [GET] /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId} — now includes additional attributes.

2. Adds a disabled state to the following attributes:

   • seats
   • recurrence
   • bookingLimitsCount
   • bookingLimitsDuration
   • bookingWindow
   • confirmationPolicy

   Commits related to this change:

   • 83ae1a6
   • e3938af

3. Refactors the codebase to implement pipes for transforming input data and uses interceptors for transforming output data. The goal is to keep the service layer cleaner by handling transformation logic at the controller level, allowing services to interact freely without duplicating transformation processes.

   Commits related to this change:

   • d2a802d — for user event types
   • 4526811 — for team event types

4. Refactors our event-type input, output, and update classes to extend from a single base class. This simplifies the process of adding new attributes in the future.

   Commit related to this change:

   • a885234

---

Mandatory Tasks (DO NOT REMOVE)

• I have self-reviewed the code (A sizable PR without self-review might be rejected).
• I have added a Docs issue here if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
• I confirm automated tests are in place that prove my fix is effective or that my feature works.

---

How should this be tested?

1. Set "version": "1.2.3" in packages/platform/libraries/package.json.
2. Add "@calcom/platform-libraries-1.2.3": "npm:@calcom/[email protected]" to apps/api/v2/package.json.
3. If you encounter a Cannot write file error while running api/v2, delete the dist folder in platform/types and try running api/v2 again.

Testing api/v2/event-types:

---

1. Layout:

• Input for the handler:

  {
    "metadata": {
      "enabledLayouts": ["month_view", "column_view"],
      "defaultLayout": "month_view"
    }
  }

• API V2:

  {
    "bookerLayouts": {
      "enabledLayouts": ["column", "month", "week"],
      "defaultLayout": "month"
    }
  }

---

2. Requires Confirmation - Always:

• Input for the handler:

  {
    "requiresConfirmation": true,
    "requiresConfirmationWillBlockSlot": true
  }

• API V2:

  {
    "confirmationPolicy": {
      "type": "always",
      "blockCalendarForUnconfirmedBookings": true
    }
  }

---

3. Requires Confirmation - When booked with less than:

• Input for the handler:

  {
    "requiresConfirmation": true,
    "requiresConfirmationWillBlockSlot": true,
    "metadata": {
      "requiresConfirmationThreshold": {
        "time": 60,
        "unit": "minutes"
      }
    }
  }

• API V2:

  {
    "confirmationPolicy": {
      "type": "always",
      "blockCalendarForUnconfirmedBookings": true,
      "noticeThreshold": {
        "count": 60,
        "unit": "minutes"
      }
    }
  }

---

4. Requires Confirmation - Disabled:

• Input for the handler:

  {
    "requiresConfirmation": false,
    "requiresConfirmationWillBlockSlot": false
  }

• API V2:

  {
    "confirmationPolicy": {
      "disabled": true
    }
  }

---

5. Requires Booker Email Verification:

• Input for the handler:

  {
    "requiresBookerEmailVerification": true
  }

• API V2:

  {
    "requiresBookerEmailVerification": true
  }

---

6. Hide Notes in Calendar:

• Input for the handler:

  {
    "hideCalendarNotes": true
  }

• API V2:

  {
    "hideCalendarNotes": true
  }

---

7. Offer Seats:

• Input for the handler:

  {
    "seatsPerTimeSlot": 4,
    "seatsShowAttendees": true,
    "seatsShowAvailabilityCount": true
  }

• API V2:

  {
    "seats": {
      "seatsPerTimeSlot": 4,
      "showAttendeeInfo": true,
      "showAvailabilityCount": true
    }
  }

---

8. Offer Seats — Disabled:

• Input for the handler:

  {
    "seatsPerTimeSlot": null
  }

• API V2:

  {
    "seats": {
      "disabled": true
    }
  }

---

9. Lock Timezone on Booking Page:

• Input for the handler:

  {
    "lockTimeZoneToggleOnBookingPage": true
  }

• API V2:

  {
    "lockTimeZoneToggleOnBookingPage": true
  }

---

10. Event Type Color:

• Input for the handler:

  {
    "eventTypeColor": {
      "lightEventTypeColor": "#292929",
      "darkEventTypeColor": "#fafafa"
    }
  }

• API V2:

  {
    "color": {
      "lightThemeHex": "#292929",
      "darkThemeHex": "#fafafa"
    }
  }

---

11. Custom Event Name:

• Input for the handler:

  {
    "eventName": "{Event type title} between {Organiser} and {Scheduler}"
  }

• API V2:

  {
    "customName": "{Event type title} between {Organiser} and {Scheduler}"
  }

  Valid Variables that can be used in the custom event name:

  • {Event type title}
  • {Organiser}
  • {Scheduler}
  • {Location}
  • {Organiser first name}
  • {Scheduler first name}
  • {Scheduler last name}
  • {Event duration}
  • {LOCATION}
  • {HOST/ATTENDEE}
  • {HOST}
  • {ATTENDEE}
  • {USER}

---

12. Destination Calendar:

• Input for the handler:

  {
    "destinationCalendar": {
      "integration": "google_calendar",
      "externalId": "[email protected]"
    }
  }

• API V2:

  {
    "destinationCalendar": {
      "integration": "google_calendar",
      "externalId": "[email protected]"
    }
  }

  Note on Testing:
  Testing this feature requires a connected calendar. Here's how you can test it:

  1. Use the example app to connect a Google Calendar to your account.
  2. Retrieve the user ID of the account (found in the platform dashboard).
  3. In Postman, force refresh the access token for the user ID.
  4. Use the refreshed access token to call the following API:

     POST http://localhost:5555/v2/calendars
     

     This API will return a list of destinationCalendars connected to the account.
  5. Choose an externalId and integration from the response and use them in the create-event type payload as shown above.

---

13. Use Event Type Destination Calendar Email:

• Input for the handler:

  {
    "useEventTypeDestinationCalendarEmail": true
  }

• API V2:

  {
    "useDestinationCalendarEmail": true
  }

  Note on Enabling:
  To enable this, a calendar must already be connected to your account.