* feat: add API endpoint to fetch Google Calendar meeting details and metrics * refactor: rename eventId to eventUid and update calendar event details endpoint * feat: implement Google Calendar service account delegation for event details * refactor: simplify Google Calendar event response * refactor: simplify calendar event details endpoint * feat: add calendar event details endpoint with schema and controller implementation * chore: reset platform libraries package version to 0.0.0 * refactor: migrate calendar event details to unified calendars module * Update gcal.service.ts * refactor: update calendar event schema with title and locations fields replacing summary and conferenceData * feat: update calendar event source to use enum type for better validation * update api description * refactor: make Google Calendar service methods private * refactor: remove location field from unified calendar event output * fix: update Google Calendar event location type property to match unified schema * feat: add CalendarEventStatus enum and map Google Calendar statuses to standardized values * docs: add property descriptions to calendar event schema and remove organizer field * fix: change calendar event locations type from null to empty array in unified calendar API * feat: make calendar source field required * refactor: replace organizer field with hosts array in Google calendar event mapping * feat: enhance calendar event location API documentation with detailed property descriptions * feat: add calendar event details endpoint documentation * fix: typo * docs: update calendar event details API description to remove reschedule history reference * refactor: rename uri to url in calendar event location interfaces and mappings * refactor: improve calendar event response status handling and code organization * Update get-unified-calendar-event.ts * update docs * chore: update @calcom/platform-libraries to version 0.0.215
A progressive Node.js framework for building efficient and scalable server-side applications.
Description
Cal.com is using the Nest framework TypeScript starter repository.
Installation
$ yarn install
Prisma setup
$ yarn prisma generate
Env setup
Copy .env.example to .env and fill values.
Add license Key to deployments table in DB
id, logo theme licenseKey agreedLicenseAt 1, null, null, 'c4234812-12ab-42s6-a1e3-55bedd4a5bb7', '2023-05-15 21:39:47.611'
your CALCOM_LICENSE_KEY env var need to contain the same value
.env CALCOM_LICENSE_KEY=c4234812-12ab-42s6-a1e3-55bedd4a5bb
Running the app
Development
$ yarn run start
OR if you don't want to use docker, you can run following command.
$ yarn dev:no-docker
Additionally you can run following command(in different terminal) to ensure that any change in any of the dependencies is rebuilt and detected. It watches platform-libraries, platform-constants, platform-enums, platform-utils, platform-types.
$ yarn run dev:build:watch
If you are making changes in packages/platform/libraries, you should run the following command too that would connect your local packages/platform/libraries to the api/v2
$ yarn local
watch mode
$ yarn run start:dev
production mode
$ yarn run start:prod
## Test
```bash
# unit tests
$ yarn run test
# e2e tests
$ yarn run test:e2e
# e2e tests in watch mode
$ yarn test:e2e:watch
# run specific e2e test file in watch mode
$ yarn test:e2e:watch --testPathPattern=filePath
# test coverage
$ yarn run test:cov
Conventions
Guards
- In case a guard would return "false" for "canActivate" instead throw ForbiddenException with an error message containing guard name and the error.
- In case a guard would return "false" for "canActivate" DO NOT cache the result in redis, because we don't want that someone is forbidden, updates whatever was the problem, and then has to wait for cache to expire. We only cache in redis guard results where "canAccess" is "true".
- If you use ApiAuthGuard but want that only specific auth method is allowed, for example, api key, then you also need to add
@ApiAuthGuardOnlyAllow(["API_KEY"])under the@UseGuards(ApiAuthGuard). Shortly, useApiAuthGuardOnlyAllowto specify which auth methods are allowed byApiAuthGuard. IfApiAuthGuardOnlyAllowis not used or nothing is passed to it or empty array it means that all auth methods are allowed.
Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
Stay in touch
- Author - Kamil Myśliwiec
- Website - https://nestjs.com
- Twitter - @nestframework
License
Nest is MIT licensed.