feat: field mapping and custom schema

.gitignore

@@ -85,3 +85,4 @@ npm-debug.log*
 !.github/**/*.yml
 !fern/**/*.yml
 revert-dev.js
+.yarn/install-state.gz

fern/api/definition/common/types.yml

@@ -49,6 +49,16 @@ types:
             - zohocrm
             - sfdc
             - pipedrive
+    StandardObject:
+        enum:
+            - company
+            - contact
+            - deal
+            - event
+            - lead
+            - note
+            - task
+            - user
     ResponseStatus:
         enum:
             - ok

fern/api/definition/crm/field-mapping/field-mapping.yml

@@ -0,0 +1,75 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json
+
+imports:
+    errors: ../../common/errors.yml
+    types: ../../common/types.yml
+
+types:
+    MappableFieldType:
+        properties:
+            fieldName: string
+            objectName: types.StandardObject
+    FieldDetailsType:
+        properties:
+            fieldName: string
+            fieldType: string
+            fieldDescription: string
+    FieldMappingType:
+        properties:
+            sourceFieldName: string
+            targetFieldName: string
+            object: string
+    GetFieldMappingResponse:
+        properties:
+            canAddCustomMapping: boolean
+            mappableFields: list<MappableFieldType>
+            fieldList: unknown
+    CreateFieldMappingRequestBody:
+        properties:
+            standardMappings: list<FieldMappingType>
+            customMappings: list<FieldMappingType>
+    CreateFieldMappingResponse:
+        properties:
+            status: types.ResponseStatus
+
+service:
+    base-path: /crm/field-mapping
+    auth: false
+    headers:
+        x-revert-api-token:
+            type: optional<string>
+            docs: Your official API key for accessing revert apis.
+        x-revert-t-id:
+            type: string
+            docs: The unique customer id used when the customer linked their account.
+        x-revert-t-token:
+            type: optional<string>
+            docs: The temp used to identify tenant.
+        x-api-version:
+            type: optional<string>
+            docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
+    audiences:
+        - external
+    endpoints:
+        getFieldMapping:
+            docs: Get field mappings for a connection
+            method: GET
+            path: ''
+            request:
+                name: GetFieldMappingRequest
+            response: GetFieldMappingResponse
+            errors:
+                - errors.UnAuthorizedError
+                - errors.InternalServerError
+        createFieldMapping:
+            docs: Create field mappings for a connection
+            method: POST
+            path: ''
+            request:
+                name: CreateFieldMappingRequest
+                body: CreateFieldMappingRequestBody
+            response: CreateFieldMappingResponse
+            errors:
+                - errors.UnAuthorizedError
+                - errors.InternalServerError
+                - errors.NotFoundError

fern/api/definition/crm/properties.yml

@@ -0,0 +1,64 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json
+
+imports:
+    errors: ../common/errors.yml
+    types: ../common/types.yml
+
+types:
+    FieldDetailsType:
+        properties:
+            fieldName: string
+            fieldType: string
+            fieldDescription: string
+    FieldDetailsTypeRequest:
+        extends: FieldDetailsType
+        properties:
+            groupName: string
+            type: string
+    SetObjectPropertiesRequest: FieldDetailsTypeRequest
+    GetObjectPropertiesResponse: unknown
+    SetObjectPropertiesResponse: unknown
+
+service:
+    base-path: /crm/properties
+    auth: false
+    headers:
+        x-revert-api-token:
+            type: string
+            docs: Your official API key for accessing revert apis.
+        x-revert-t-id:
+            type: string
+            docs: The unique customer id used when the customer linked their account.
+        x-api-version:
+            type: optional<string>
+            docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
+    audiences:
+        - external
+    endpoints:
+        getObjectProperties:
+            docs: Get object properties for connection
+            method: GET
+            path: /{objectName}
+            path-parameters:
+                objectName: types.StandardObject
+            request:
+                name: GetObjectPropertiesRequest
+            response: GetObjectPropertiesResponse
+            errors:
+                - errors.UnAuthorizedError
+                - errors.InternalServerError
+                - errors.NotFoundError
+        setCustomProperties:
+            docs: Set custom properties on an object for a given connection
+            method: POST
+            path: /{objectName}
+            path-parameters:
+                objectName: types.StandardObject
+            request:
+                name: SetObjectCustomPropertiesRequest
+                body: SetObjectPropertiesRequest
+            response: SetObjectPropertiesResponse
+            errors:
+                - errors.UnAuthorizedError
+                - errors.InternalServerError
+                - errors.NotFoundError

package.json

@@ -5,6 +5,7 @@
         "packages/*"
     ],
     "devDependencies": {
+        "concurrently": "^8.2.1",
         "fern-api": "0.12.0",
         "husky": "^8.0.3",
         "lint-staged": "^14.0.1",
@@ -17,7 +18,8 @@
         "fern-docs": "fern generate --group external",
         "build": "yarn workspaces foreach run build",
         "prepare": "husky install",
-        "lint": "lint-staged"
+        "lint": "lint-staged",
+        "dev:all": "concurrently --kill-others \"yarn workspace @revertdotdev/js dev\" \"yarn workspace @revertdotdev/backend dev\" \"yarn workspace @revertdotdev/revert-ui start\" "
     },
     "prisma": {
         "schema": "packages/backend/prisma/schema.prisma",

packages/backend/constants/associations.ts

@@ -0,0 +1,19 @@
+import { Subtype } from "./typeHelpers";
+
+export type AllAssociation = 'contactId' | 'companyId' | 'leadId' | 'dealId' | 'noteId';
+
+export type CompanyAssociation = Subtype<AllAssociation, 'dealId'>;
+
+export type ContactAssociation = Subtype<AllAssociation, 'dealId'>;
+
+export type DealAssociation = Subtype<AllAssociation, 'contactId' | 'companyId'>;
+
+export type EventAssociation = Subtype<AllAssociation, 'dealId' | 'contactId'>;
+
+export type LeadAssociation = Subtype<AllAssociation, 'contactId' | 'companyId' | 'dealId'>;
+
+export type NoteAssociation = Subtype<AllAssociation, 'contactId' | 'companyId' | 'leadId' | 'dealId'>;
+
+export type TaskAssociation = Subtype<AllAssociation, 'dealId'>;
+
+export type UserAssociation = Subtype<AllAssociation, 'dealId'>;

packages/backend/constants/common.ts

@@ -36,4 +36,73 @@ export const DEFAULT_SCOPE = {
     [TP_ID.pipedrive]: [],
 };
 
-export type AllAssociation = 'contactId' | 'companyId' | 'leadId' | 'dealId' | 'noteId';
+export const mapIntegrationIdToIntegrationName = {
+    [TP_ID.hubspot]: "Hubspot",
+    [TP_ID.pipedrive]: "Pipedrive",
+    [TP_ID.sfdc]: "Salesforce",
+    [TP_ID.zohocrm]: "Zoho",
+}
+
+export const rootSchemaMappingId = 'revertRootSchemaMapping';
+
+export enum StandardObjects {
+    company = 'company',
+    contact = 'contact',
+    deal = 'deal',
+    event = 'event',
+    lead = 'lead',
+    note = 'note',
+    task = 'task',
+    user = 'user',
+}
+
+export const objectNameMapping: Record<string, Record<TP_ID, string | undefined>> = {
+    [StandardObjects.company]: {
+        [TP_ID.hubspot]: 'companies',
+        [TP_ID.pipedrive]: 'organization',
+        [TP_ID.sfdc]: 'Account',
+        [TP_ID.zohocrm]: 'Accounts',
+    },
+    [StandardObjects.contact]: {
+        [TP_ID.hubspot]: 'contacts',
+        [TP_ID.pipedrive]: 'person',
+        [TP_ID.sfdc]: 'Contact',
+        [TP_ID.zohocrm]: 'Contacts',
+    },
+    [StandardObjects.deal]: {
+        [TP_ID.hubspot]: 'deals',
+        [TP_ID.pipedrive]: 'deal',
+        [TP_ID.sfdc]: 'Opportunity',
+        [TP_ID.zohocrm]: 'Deals',
+    },
+    [StandardObjects.event]: {
+        [TP_ID.hubspot]: 'meetings',
+        [TP_ID.pipedrive]: 'activity',
+        [TP_ID.sfdc]: 'Event',
+        [TP_ID.zohocrm]: 'Events',
+    },
+    [StandardObjects.lead]: {
+        [TP_ID.hubspot]: 'contacts',
+        [TP_ID.pipedrive]: 'lead',
+        [TP_ID.sfdc]: 'Lead',
+        [TP_ID.zohocrm]: 'Leads',
+    },
+    [StandardObjects.note]: {
+        [TP_ID.hubspot]: 'notes',
+        [TP_ID.pipedrive]: 'note',
+        [TP_ID.sfdc]: 'Note',
+        [TP_ID.zohocrm]: 'Notes',
+    },
+    [StandardObjects.task]: {
+        [TP_ID.hubspot]: 'tasks',
+        [TP_ID.pipedrive]: 'activity',
+        [TP_ID.sfdc]: 'Task',
+        [TP_ID.zohocrm]: 'Tasks',
+    },
+    [StandardObjects.user]: {
+        [TP_ID.hubspot]: 'users',
+        [TP_ID.pipedrive]: undefined,
+        [TP_ID.sfdc]: 'User',
+        [TP_ID.zohocrm]: 'users',
+    },
+};