3a8fe8c7af
* perf(app-store): convert services to factory functions to narrow SDK type exports This change converts CRM, Calendar, Payment, and Analytics services from exporting classes to exporting factory functions that return interface types. This prevents SDK types (HubSpot, Stripe, etc.) from leaking into the type system when TypeScript emits .d.ts files. Services modified: - CRM: hubspot, salesforce, closecom, pipedrive-crm, zoho-bigin, zohocrm - Calendar: all 13 calendar services - Payment: stripe, paypal, alby, btcpayserver, hitpay, mock-payment-app - Analytics: dub Video adapters were audited and already use factory pattern. WIP: Salesforce CRM service has a type error that needs fixing. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(salesforce): add type assertion for appOptions in factory function Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: update remaining consumers to use factory functions - getAnalytics.ts: call factory function instead of new - getConnectedApps.ts: call factory function instead of new - salesforce/CrmService.ts: fix type assertion with default value - salesforce/routingForm/incompleteBookingAction.ts: use factory function - salesforce/routingFormBookingFormHandler.ts: use factory function Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(salesforce): add SalesforceCRM interface for Salesforce-specific methods - Create SalesforceCRM interface extending CRM with findUserEmailFromLookupField and incompleteBookingWriteToRecord methods - Add createSalesforceCrmServiceWithSalesforceType factory function for internal Salesforce modules - Update routing form files to use the new factory function with proper typing Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(salesforce): correct return type in SalesforceCRM interface The findUserEmailFromLookupField method returns { email: string; recordType: RoutingReasons } | undefined, not string | undefined. Updated the interface to match the actual implementation. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: update all call sites to use factory functions - Update calendar API add files to use factory functions (7 files) - Update Google Calendar test files to use factory functions (3 files) - Update Salesforce test files to use SalesforceCRM interface - Add testMode parameter to createSalesforceCrmServiceWithSalesforceType - Remove unused @ts-expect-error directive in bookingScenario.ts Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: add GoogleCalendar interface and update factory functions for service-specific methods Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: add type annotation to attendee parameter in google-calendar.e2e.ts Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: update selected-calendars/route.ts to use GoogleCalendar factory function Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: update remaining GoogleCalendarService call sites to use factory function Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: remove explicit type annotation in google-calendar.e2e.ts to fix type error Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: update test mocks to use factory function pattern for calendar and payment services Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix: convert MockPaymentService to factory function in setupVitest.ts Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(api-v2): call calendar service factory functions instead of using new Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * perf(trpc): add TypeScript project references to reduce build file count - Add tsconfig.build.json to app-store with composite settings for declaration emit - Add tsconfig.server.build.json to trpc with project references - Add types and typesVersions to app-store package.json to redirect type resolution to dist-types - Add build:types script to app-store for generating declarations - Add dist-types to .gitignore This reduces the tRPC build file count from 7,733 to 5,618 files (27% reduction) by having TypeScript resolve to prebuilt .d.ts files instead of source files. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(app-store): add fallback to typesVersions for CI compatibility The typesVersions now prefers dist-types but falls back to source files when dist-types don't exist. This fixes CI type-check failures while still allowing the optimization when dist-types are built. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * Added build dependency for tRPC on app-store * fix(app-store): exclude test directories from tsconfig.build.json Exclude __tests__, __mocks__, and tests directories from the build config to prevent test utility files (which import from outside rootDir) from being included in the declaration emit. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(turbo): add build:types task definition for app-store Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(turbo): remove circular build dependency between trpc and app-store The build:types task for app-store transitively imports from @calcom/features, which imports from @calcom/trpc. This creates a circular build dependency when @calcom/trpc#build depends on @calcom/app-store#build:types. Solution: Remove the turbo dependency. The typesVersions fallback pattern ['./dist-types/*', './*'] will use source files when dist-types/ doesn't exist, and use prebuilt declarations when they do exist (for faster builds). Also exclude dist-types from regular tsconfig.json to prevent 'Cannot write file' errors when dist-types/ exists. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * refactor(app-store): rename dist-types to types for consistency Rename the prebuilt TypeScript declarations folder from dist-types to types to match the convention used by @calcom/trpc and other packages in the monorepo. Updated files: - tsconfig.build.json: declarationDir and exclude - tsconfig.json: exclude - package.json: typesVersions paths - turbo.json: build:types outputs - .gitignore: ignore path Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(api-v2): update ICS calendar test to mock factory function instead of class prototype The IcsFeedCalendarService is now a factory function, not a class, so jest.spyOn(IcsFeedCalendarService.prototype, 'listCalendars') no longer works. Updated to use jest.spyOn(appStore, 'IcsFeedCalendarService').mockImplementation() to mock the factory function return value instead. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * refactor(app-store): rename factory functions to Build* naming convention - Rename Calendar factory functions from create*CalendarService to BuildCalendarService - Rename CRM factory functions from create*CrmService to BuildCrmService - Rename Payment factory functions from PaymentService to BuildPaymentService - Rename Analytics factory function from createDubAnalyticsService to BuildAnalyticsService - Update all index.ts re-exports to use new names - Update all call sites throughout the codebase - Update test mocks to use new factory function names This makes it clear that these are factory functions, not class constructors. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(app-store): update remaining CalendarService and PaymentService imports to Build* names - Update api/add.ts files for applecalendar, caldavcalendar, exchange2013calendar, exchange2016calendar, exchangecalendar, ics-feedcalendar - Update mock-payment-app index.ts to export BuildPaymentService - Fix googlecalendar test import alias for createInMemoryDelegationCredentialForBuildCalendarService Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(tests): update payment service mocks to use BuildPaymentService - Update setupVitest.ts to use BuildPaymentService instead of PaymentService - Update handlePayment.test.ts mock to use BuildPaymentService Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * refactor: address PR review comments - rename to Build* and remove unused code Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * refactor: remove explanatory comments and fix indentation Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * chore: update .gitignore to use *.tsbuildinfo pattern Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * fix(api-v2): update IcsFeedCalendarService to BuildIcsFeedCalendarService in e2e test Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * style: format CalendarService.test.ts Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * Delete apps/ui-playground/next-env.d.ts --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
224 lines
7.2 KiB
TypeScript
224 lines
7.2 KiB
TypeScript
import z from "zod";
|
|
|
|
import type { CloseComFieldOptions } from "@calcom/lib/CloseCom";
|
|
import CloseCom from "@calcom/lib/CloseCom";
|
|
import { getCustomActivityTypeInstanceData } from "@calcom/lib/CloseComeUtils";
|
|
import { symmetricDecrypt } from "@calcom/lib/crypto";
|
|
import logger from "@calcom/lib/logger";
|
|
import type { CalendarEvent } from "@calcom/types/Calendar";
|
|
import type { CredentialPayload } from "@calcom/types/Credential";
|
|
import type { CRM, ContactCreateInput, CrmEvent, Contact } from "@calcom/types/CrmService";
|
|
|
|
// Schema that supports both OAuth and API key credentials
|
|
const credentialSchema = z
|
|
.object({
|
|
encrypted: z.string().optional(),
|
|
access_token: z.string().optional(),
|
|
refresh_token: z.string().optional(),
|
|
expires_at: z.number().optional(),
|
|
})
|
|
.refine(
|
|
(data) => {
|
|
// Either encrypted (API key) or access_token (OAuth) must be present
|
|
return !!data.encrypted || !!data.access_token;
|
|
},
|
|
{
|
|
message: "Either API key or OAuth credentials must be provided",
|
|
}
|
|
);
|
|
|
|
const CALENDSO_ENCRYPTION_KEY = process.env.CALENDSO_ENCRYPTION_KEY || "";
|
|
|
|
// Cal.com Custom Activity Fields
|
|
const calComCustomActivityFields: CloseComFieldOptions = [
|
|
// Field name, field type, required?, multiple values?
|
|
["Attendees", "contact", false, true],
|
|
["Date & Time", "datetime", true, false],
|
|
["Time zone", "text", true, false],
|
|
["Organizer", "contact", true, false],
|
|
["Additional notes", "text", false, false],
|
|
];
|
|
|
|
/**
|
|
* Authentication
|
|
* Close.com provides OAuth for authentication.
|
|
*
|
|
* Meeting creation
|
|
* Close.com does not expose a "Meeting" API, it may be available in the future.
|
|
*
|
|
* Per Close.com documentation (https://developer.close.com/resources/custom-activities):
|
|
* "To work with Custom Activities, you will need to create a Custom Activity Type and
|
|
* likely add one or more Activity Custom Fields to that type. Once the Custom Activity
|
|
* Type is defined, you can create Custom Activity instances of that type as you would
|
|
* any other activity."
|
|
*
|
|
* Contact creation
|
|
* Every contact in Close.com need to belong to a Lead. When creating a contact in
|
|
* Close.com as part of this integration, a new generic Lead will be created in order
|
|
* to assign every contact created by this process, and it is named "From Cal.com"
|
|
*/
|
|
class CloseComCRMService implements CRM {
|
|
private integrationName = "";
|
|
private closeCom: CloseCom;
|
|
private log: typeof logger;
|
|
|
|
constructor(credential: CredentialPayload) {
|
|
this.integrationName = "closecom_other_calendar";
|
|
this.log = logger.getSubLogger({ prefix: [`[[lib] ${this.integrationName}`] });
|
|
|
|
const parsedKey = credentialSchema.safeParse(credential.key);
|
|
|
|
if (!parsedKey.success) {
|
|
throw new Error(
|
|
`Invalid credentials for userId ${credential.userId} and appId ${credential.appId}: ${parsedKey.error}`
|
|
);
|
|
}
|
|
|
|
// Initialize CloseCom client based on credential type
|
|
if (parsedKey.data.encrypted) {
|
|
// API key authentication
|
|
const decrypted = symmetricDecrypt(parsedKey.data.encrypted, CALENDSO_ENCRYPTION_KEY);
|
|
const { api_key } = JSON.parse(decrypted);
|
|
this.closeCom = new CloseCom(api_key);
|
|
} else if (parsedKey.data.access_token) {
|
|
// OAuth authentication
|
|
this.closeCom = new CloseCom(parsedKey.data.access_token, {
|
|
refresh_token: parsedKey.data.refresh_token,
|
|
expires_at: parsedKey.data.expires_at,
|
|
isOAuth: true,
|
|
userId: credential.userId!,
|
|
});
|
|
} else {
|
|
throw new Error("No valid authentication method found");
|
|
}
|
|
}
|
|
|
|
closeComUpdateCustomActivity = async (uid: string, event: CalendarEvent) => {
|
|
const customActivityTypeInstanceData = await getCustomActivityTypeInstanceData(
|
|
event,
|
|
calComCustomActivityFields,
|
|
this.closeCom
|
|
);
|
|
// Create Custom Activity type instance
|
|
const customActivityTypeInstance = await this.closeCom.activity.custom.create(
|
|
customActivityTypeInstanceData
|
|
);
|
|
return this.closeCom.activity.custom.update(uid, customActivityTypeInstance);
|
|
};
|
|
|
|
closeComDeleteCustomActivity = async (uid: string) => {
|
|
return this.closeCom.activity.custom.delete(uid);
|
|
};
|
|
|
|
async createEvent(event: CalendarEvent): Promise<CrmEvent> {
|
|
const customActivityTypeInstanceData = await getCustomActivityTypeInstanceData(
|
|
event,
|
|
calComCustomActivityFields,
|
|
this.closeCom
|
|
);
|
|
// Create Custom Activity type instance
|
|
const customActivityTypeInstance = await this.closeCom.activity.custom.create(
|
|
customActivityTypeInstanceData
|
|
);
|
|
return Promise.resolve({
|
|
uid: customActivityTypeInstance.id,
|
|
id: customActivityTypeInstance.id,
|
|
type: this.integrationName,
|
|
password: "",
|
|
url: "",
|
|
additionalInfo: {
|
|
customActivityTypeInstanceData,
|
|
},
|
|
success: true,
|
|
});
|
|
}
|
|
|
|
async updateEvent(uid: string, event: CalendarEvent): Promise<CrmEvent> {
|
|
const updatedEvent = await this.closeComUpdateCustomActivity(uid, event);
|
|
return {
|
|
id: updatedEvent.id,
|
|
};
|
|
}
|
|
|
|
async deleteEvent(uid: string): Promise<void> {
|
|
await this.closeComDeleteCustomActivity(uid);
|
|
}
|
|
|
|
async getContacts({ emails }: { emails: string | string[] }): Promise<Contact[]> {
|
|
const contactsQuery = await this.closeCom.contact.search({
|
|
emails: Array.isArray(emails) ? emails : [emails],
|
|
});
|
|
|
|
return contactsQuery.data.map((contact) => {
|
|
return {
|
|
id: contact.id,
|
|
email: contact.emails[0].email,
|
|
name: contact.name,
|
|
};
|
|
});
|
|
}
|
|
|
|
async createContacts(contactsToCreate: ContactCreateInput[]): Promise<Contact[]> {
|
|
// In Close.com contacts need to be attached to a lead
|
|
// Assume all attendees in an event belong under a lead
|
|
|
|
const contacts = [];
|
|
|
|
// Create main lead
|
|
const lead = await this.closeCom.lead.create({
|
|
contactName: contactsToCreate[0].name,
|
|
contactEmail: contactsToCreate[0].email,
|
|
});
|
|
|
|
contacts.push({
|
|
id: lead.contacts[0].id,
|
|
email: lead.contacts[0].emails[0].email,
|
|
});
|
|
|
|
// Check if we need to crate more contacts under the lead
|
|
if (contactsToCreate.length > 1) {
|
|
const createContactPromise = [];
|
|
for (const contact of contactsToCreate) {
|
|
createContactPromise.push(
|
|
this.closeCom.contact.create({
|
|
leadId: lead.id,
|
|
person: {
|
|
email: contact.email,
|
|
name: contact.name,
|
|
},
|
|
})
|
|
);
|
|
const createdContacts = await Promise.all(createContactPromise);
|
|
for (const createdContact of createdContacts) {
|
|
contacts.push({
|
|
id: createdContact.id,
|
|
email: createdContact.emails[0].email,
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
return contacts;
|
|
}
|
|
|
|
getAppOptions() {
|
|
console.log("No options implemented");
|
|
}
|
|
|
|
async handleAttendeeNoShow() {
|
|
console.log("Not implemented");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Factory function that creates a Close.com CRM service instance.
|
|
* This is exported instead of the class to prevent internal types
|
|
* from leaking into the emitted .d.ts file.
|
|
*/
|
|
export default function BuildCrmService(
|
|
credential: CredentialPayload,
|
|
_appOptions?: Record<string, unknown>
|
|
): CRM {
|
|
return new CloseComCRMService(credential);
|
|
}
|