Files
calendar/packages/platform/libraries
e0527587c1 feat: routing forms for api v2 (#18885)
* init router endpoint for v2

* fixup fixup

* resolve merge conflicts

* update libraries

* update router controller

* make router endpoint public

* chore: refactor router endpoint and add team/org id

* cleanup

* chore: Only import Sentry when needed (#18882)

* perf: prerender routes in main navigation (#18883)

* chore: migrate /apps/categories pages (#18871)

* migrate apps/categories pages

* remove pages dir

* chore: app router - /payment pages (#18152)

* remove Head from payment page comp

* remove route from pages router

* move out of future folder

* add to config.matcher

* remove unneeded code

* update middleware

* fix

* fix

* perf: replace `getServerSessionForAppDir` usages with our original `getServerSession` function (#18897)

* chore: migrate /apps/installation pages (#18870)

* migrate apps/installation pages

* fix test

* chore: migrate `/auth/logout` (#18901)

* migrate /auth/verify-email page

* update middleware

* migrate /auth/logout page

* expose router endpoint

* small refactor pageprops not necessary

* sentry is already tracking performance

* reuse logic

* fixup! reuse logic

* fixup! fixup! reuse logic

* fixup! fixup! fixup! reuse logic

---------

Co-authored-by: Morgan Vernay <morgan@cal.com>
Co-authored-by: Alex van Andel <me@alexvanandel.com>
Co-authored-by: Benny Joo <sldisek783@gmail.com>
Co-authored-by: Morgan <33722304+ThyMinimalDev@users.noreply.github.com>
2025-01-27 19:02:11 +00:00
..

How to work with platform libraries in Dev

We version this package using NPM: https://www.npmjs.com/package/@calcom/platform-libraries?activeTab=code

Here is the workflow:

  1. If you change platform libraries for the first time, then run yarn local to build them locally for the first time. This will also make v2 api point to the local libraries.
  2. If you change them for the second time, then run yarn build:dev to re-build them.
  3. Once you are happy with platform libraries:
  • run yarn publish - it will check "@calcom/platform-libraries" version in npm and update it's package.json to the next version and then it will publish the package to np.
  • run yarn postpublish - it will update the version of "@calcom/platform-libraries" in the api v2 package.json, reset "@calcom/platform-libraries" to 0.0.0 and run yarn install.

note(Lauris) - we could have 1 publish script but the problem is that yarn publish does not exit for some reason.

Before Merging to main

  • Publish Your Version of Libraries on NPM:
    • To publish, ensure you are a contributor to the platform libraries' NPM package.
    • Authenticate yourself via the CLI using npm auth.
    • Increment the version number accordingly.
    • Run yarn publish to publish your version.
  • Once it's published, change back the version in packages/platform/libraries/package.json back to 0.0.0
  • Run yarn
  • You should now be using the npm package instead of the locally built version

When to publish new version of platform libraries

  • New exports in the index.js of platform libraries
  • Code change in the functions already exported
  • Prisma schema change breaking implementation of functions in the currently used releases of platform libraries