Add Github Connector

.env.example

@@ -95,7 +95,9 @@ FRONT_TICKETING_CLOUD_CLIENT_SECRET=
 # Gitlab
 GITLAB_TICKETING_CLOUD_CLIENT_ID=
 GITLAB_TICKETING_CLOUD_CLIENT_SECRET=
-
+# Github
+GITHUB_TICKETING_CLOUD_CLIENT_ID=
+GITHUB_TICKETING_CLOUD_CLIENT_SECRET=
 # ================================================
 # File Storage
 # ================================================

packages/api/prisma/schema.prisma

@@ -189,7 +189,7 @@ model crm_contacts {
 model crm_deals {
   id_crm_deal        String            @id(map: "pk_crm_deal") @db.Uuid
   name               String
-  description        String?
+  description        String
   amount             BigInt
   created_at         DateTime          @db.Timestamp(6)
   modified_at        DateTime          @db.Timestamp(6)
@@ -503,7 +503,6 @@ model tcg_collections {
   remote_platform   String?
   collection_type   String?
   parent_collection String?  @db.Uuid
-  id_tcg_ticket     String?  @db.Uuid
   created_at        DateTime @db.Timestamp(6)
   modified_at       DateTime @db.Timestamp(6)
   id_linked_user    String   @db.Uuid
@@ -518,14 +517,14 @@ model tcg_comments {
   is_private        Boolean?
   remote_id         String?
   remote_platform   String?
+  created_at        DateTime?         @db.Timestamp(6)
+  modified_at       DateTime?         @db.Timestamp(6)
   creator_type      String?
   id_tcg_attachment String[]
   id_tcg_ticket     String?           @db.Uuid
   id_tcg_contact    String?           @db.Uuid
   id_tcg_user       String?           @db.Uuid
   id_linked_user    String?           @db.Uuid
-  created_at        DateTime?         @db.Timestamp(6)
-  modified_at       DateTime?         @db.Timestamp(6)
   id_connection     String            @db.Uuid
   tcg_attachments   tcg_attachments[]
   tcg_tickets       tcg_tickets?      @relation(fields: [id_tcg_ticket], references: [id_tcg_ticket], onDelete: NoAction, onUpdate: NoAction, map: "fk_40_1")
@@ -596,14 +595,14 @@ model tcg_tickets {
   collections     String[]
   completed_at    DateTime?         @db.Timestamp(6)
   priority        String?
+  created_at      DateTime          @db.Timestamp(6)
+  modified_at     DateTime          @db.Timestamp(6)
   assigned_to     String[]
   remote_id       String?
   remote_platform String?
   creator_type    String?
   id_tcg_user     String?           @db.Uuid
-  id_linked_user  String?           @db.Uuid
-  created_at      DateTime          @db.Timestamp(6)
-  modified_at     DateTime          @db.Timestamp(6)
+  id_linked_user  String            @db.Uuid
   id_connection   String            @db.Uuid
   tcg_attachments tcg_attachments[]
   tcg_comments    tcg_comments[]
@@ -620,10 +619,10 @@ model tcg_users {
   remote_id       String?
   remote_platform String?
   teams           String[]
-  id_linked_user  String?        @db.Uuid
-  id_connection   String         @db.Uuid
   created_at      DateTime?      @db.Timestamp(6)
   modified_at     DateTime?      @db.Timestamp(6)
+  id_linked_user  String?        @db.Uuid
+  id_connection   String         @db.Uuid
   tcg_comments    tcg_comments[]
 }
 
@@ -678,6 +677,7 @@ model connector_sets {
   crm_zendesk      Boolean?
   crm_close        Boolean?
   fs_box           Boolean?
+  tcg_github       Boolean?
   projects         projects[]
 }
 
@@ -1640,6 +1640,7 @@ model acc_vendor_credits {
   accounting_period    String?   @db.Uuid
 }
 
+
 model ecom_customers {
   id_ecom_customer String           @id(map: "pk_ecom_customers") @db.Uuid
   remote_id        String?

packages/api/scripts/init.sql

@@ -374,7 +374,8 @@ CREATE TABLE connector_sets
  crm_zendesk      boolean NULL,
  crm_close        boolean NULL,
  fs_box           boolean NULL,
- CONSTRAINT PK_project_connector PRIMARY KEY ( id_connector_set )
+  tcg_github boolean NULL,
+CONSTRAINT PK_project_connector PRIMARY KEY ( id_connector_set )
 );
 
 -- ************************************** connection_strategies

packages/api/scripts/seed.sql

@@ -1,10 +1,10 @@
 INSERT INTO users (id_user, identification_strategy, email, password_hash, first_name, last_name) VALUES
 ('0ce39030-2901-4c56-8db0-5e326182ec6b', 'b2c','[email protected]', '$2b$10$Y7Q8TWGyGuc5ecdIASbBsuXMo3q/Rs3/cnY.mLZP4tUgfGUOCUBlG', 'local', 'Panora');
 
-INSERT INTO connector_sets (id_connector_set, crm_hubspot, crm_zoho, crm_pipedrive, crm_attio, crm_zendesk, crm_close, tcg_zendesk, tcg_gorgias, tcg_front, tcg_jira, tcg_gitlab, fs_box) VALUES
-    ('1709da40-17f7-4d3a-93a0-96dc5da6ddd7', TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
-    ('852dfff8-ab63-4530-ae49-e4b2924407f8', TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
-    ('aed0f856-f802-4a79-8640-66d441581a99', TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
+INSERT INTO connector_sets (id_connector_set, crm_hubspot, crm_zoho, crm_pipedrive, crm_attio, crm_zendesk, crm_close, tcg_zendesk, tcg_gorgias, tcg_front, tcg_jira, tcg_gitlab, fs_box, tcg_github) VALUES
+    ('1709da40-17f7-4d3a-93a0-96dc5da6ddd7', TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
+    ('852dfff8-ab63-4530-ae49-e4b2924407f8', TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
+    ('aed0f856-f802-4a79-8640-66d441581a99', TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
 
 INSERT INTO projects (id_project, name, sync_mode, id_user, id_connector_set) VALUES
     ('1e468c15-aa57-4448-aa2b-7fed640d1e3d', 'Project 1', 'pull', '0ce39030-2901-4c56-8db0-5e326182ec6b', '1709da40-17f7-4d3a-93a0-96dc5da6ddd7'),

packages/api/src/@core/utils/types/original/original.ticketing.ts

@@ -1,3 +1,16 @@
+import { GithubCollectionInput, GithubCollectionOutput } from '@ticketing/collection/services/github/types';
+
+import { GithubCommentInput, GithubCommentOutput } from '@ticketing/comment/services/github/types';
+
+import { GithubTagInput, GithubTagOutput } from '@ticketing/tag/services/github/types';
+
+import { GithubTeamInput, GithubTeamOutput } from '@ticketing/team/services/github/types';
+
+import { GithubTicketInput, GithubTicketOutput } from '@ticketing/ticket/services/github/types';
+
+import { GithubUserInput, GithubUserOutput } from '@ticketing/user/services/github/types';
+import { GitlabUserInput, GitlabUserOutput } from '@ticketing/user/services/gitlab/types';
+
 import {
   FrontAccountInput,
   FrontAccountOutput,
@@ -131,7 +144,7 @@ export type OriginalTicketInput =
   | FrontTicketInput
   | GorgiasTicketInput
   | JiraTicketInput
-  | GitlabTicketInput;
+  | GitlabTicketInput | GithubTicketInput;
 //| JiraServiceMgmtTicketInput;
 
 /* comment */
@@ -140,14 +153,14 @@ export type OriginalCommentInput =
   | FrontCommentInput
   | GorgiasCommentInput
   | JiraCommentInput
-  | GitlabCommentInput;
+  | GitlabCommentInput | GithubCommentInput;
 //| JiraCommentServiceMgmtInput;
 /* user */
 export type OriginalUserInput =
   | ZendeskUserInput
   | FrontUserInput
   | GorgiasUserInput
-  | JiraUserInput;
+  | JiraUserInput | GithubUserInput | GitlabUserInput;
 //| JiraServiceMgmtUserInput;
 /* account */
 export type OriginalAccountInput = ZendeskAccountInput | FrontAccountInput;
@@ -163,20 +176,20 @@ export type OriginalTagInput =
   | FrontTagInput
   | GorgiasTagInput
   | JiraTagInput
-  | GitlabTagInput;
+  | GitlabTagInput | GithubTagInput;
 
 /* team */
 export type OriginalTeamInput =
   | ZendeskTeamInput
   | FrontTeamInput
   | GorgiasTeamInput
-  | JiraTeamInput;
+  | JiraTeamInput | GithubTeamInput;
 
 /* attachment */
 export type OriginalAttachmentInput = null;
 export type OriginalCollectionInput =
   | JiraCollectionInput
-  | GitlabCollectionInput;
+  | GitlabCollectionInput | GithubCollectionInput;
 
 export type TicketingObjectInput =
   | OriginalTicketInput
@@ -197,21 +210,21 @@ export type OriginalTicketOutput =
   | FrontTicketOutput
   | GorgiasTicketOutput
   | JiraTicketOutput
-  | GitlabTicketOutput;
+  | GitlabTicketOutput | GithubTicketOutput;
 
 /* comment */
 export type OriginalCommentOutput =
   | ZendeskCommentOutput
   | FrontCommentOutput
   | GorgiasCommentOutput
   | JiraCommentOutput
-  | GitlabCommentOutput;
+  | GitlabCommentOutput | GithubCommentOutput;
 /* user */
 export type OriginalUserOutput =
   | ZendeskUserOutput
   | FrontUserOutput
   | GorgiasUserOutput
-  | JiraUserOutput;
+  | JiraUserOutput | GithubUserOutput | GitlabUserOutput;
 /* account */
 export type OriginalAccountOutput = ZendeskAccountOutput | FrontAccountOutput;
 /* contact */
@@ -226,14 +239,14 @@ export type OriginalTagOutput =
   | FrontTagOutput
   | GorgiasTagOutput
   | JiraTagOutput
-  | GitlabTagOutput;
+  | GitlabTagOutput | GithubTagOutput;
 
 /* team */
 export type OriginalTeamOutput =
   | ZendeskTeamOutput
   | FrontTeamOutput
   | GorgiasTeamOutput
-  | JiraTeamOutput;
+  | JiraTeamOutput | GithubTeamOutput;
 
 /* attachment */
 export type OriginalAttachmentOutput =
@@ -246,7 +259,7 @@ export type OriginalAttachmentOutput =
 
 export type OriginalCollectionOutput =
   | JiraCollectionOutput
-  | GitlabCollectionOutput;
+  | GitlabCollectionOutput | GithubCollectionOutput;
 
 export type TicketingObjectOutput =
   | OriginalTicketOutput

packages/api/src/ticketing/collection/collection.module.ts

@@ -1,3 +1,5 @@
+import { GithubCollectionMapper } from './services/github/mappers';
+import { GithubService } from './services/github';
 import { EncryptionService } from '@@core/@core-services/encryption/encryption.service';
 import { LoggerService } from '@@core/@core-services/logger/logger.service';
 import { BullQueueModule } from '@@core/@core-services/queues/queue.module';
@@ -36,6 +38,8 @@ import { IngestDataService } from '@@core/@core-services/unification/ingest-data
     /* PROVIDERS MAPPERS */
     JiraCollectionMapper,
     GitlabCollectionMapper,
+    GithubService,
+    GithubCollectionMapper,
   ],
   exports: [SyncService, ServiceRegistry, WebhookService],
 })

packages/api/src/ticketing/collection/services/github/index.ts

@@ -0,0 +1,61 @@
+import { Injectable } from '@nestjs/common';
+import { LoggerService } from '@@core/@core-services/logger/logger.service';
+import { PrismaService } from '@@core/@core-services/prisma/prisma.service';
+import { EncryptionService } from '@@core/@core-services/encryption/encryption.service';
+import { TicketingObject } from '@ticketing/@lib/@types';
+import { ApiResponse } from '@@core/utils/types';
+import axios from 'axios';
+import { ActionType, handle3rdPartyServiceError } from '@@core/utils/errors';
+import { ServiceRegistry } from '../registry.service';
+import { ICollectionService } from '@ticketing/collection/types';
+import { GithubCollectionInput, GithubCollectionOutput } from './types';
+import { SyncParam } from '@@core/utils/types/interface';
+
+@Injectable()
+export class GithubService implements ICollectionService {
+    constructor(
+        private prisma: PrismaService,
+        private logger: LoggerService,
+        private cryptoService: EncryptionService,
+        private registry: ServiceRegistry,
+    ) {
+        this.logger.setContext(
+            TicketingObject.collection.toUpperCase() + ':' + GithubService.name,
+        );
+        this.registry.registerService('github', this);
+    }
+
+    async sync(data: SyncParam): Promise<ApiResponse<GithubCollectionOutput[]>> {
+        try {
+            const { linkedUserId } = data;
+
+            const connection = await this.prisma.connections.findFirst({
+                where: {
+                    id_linked_user: linkedUserId,
+                    provider_slug: 'github',
+                    vertical: 'ticketing',
+                },
+            });
+            const resp = await axios.get(
+                `${connection.account_url}/user/repos`,
+                {
+                    headers: {
+                        'Content-Type': 'application/json',
+                        Authorization: `Bearer ${this.cryptoService.decrypt(
+                            connection.access_token,
+                        )}`,
+                    },
+                },
+            );
+            this.logger.log(`Synced github collections !`);
+
+            return {
+                data: resp.data,
+                message: 'Github collections retrieved',
+                statusCode: 200,
+            };
+        } catch (error) {
+            throw error;
+        }
+    }
+}

packages/api/src/ticketing/collection/services/github/mappers.ts

@@ -0,0 +1,71 @@
+import { ICollectionMapper } from '@ticketing/collection/types';
+import { GithubCollectionInput, GithubCollectionOutput } from './types';
+import {
+    UnifiedTicketingCollectionInput,
+    UnifiedTicketingCollectionOutput,
+} from '@ticketing/collection/types/model.unified';
+import { MappersRegistry } from '@@core/@core-services/registries/mappers.registry';
+import { Injectable } from '@nestjs/common';
+import { Utils } from '@ticketing/@lib/@utils';
+
+
+
+@Injectable()
+export class GithubCollectionMapper implements ICollectionMapper {
+    constructor(private mappersRegistry: MappersRegistry, private utils: Utils) {
+        this.mappersRegistry.registerService(
+            'ticketing',
+            'collection',
+            'github',
+            this,
+        );
+    }
+    desunify(
+        source: UnifiedTicketingCollectionInput,
+        customFieldMappings?: {
+            slug: string;
+            remote_id: string;
+        }[],
+    ): GithubCollectionInput {
+        return;
+    }
+
+    unify(
+        source: GithubCollectionOutput | GithubCollectionOutput[],
+        connectionId: string,
+        customFieldMappings?: {
+            slug: string;
+            remote_id: string;
+        }[],
+    ): UnifiedTicketingCollectionOutput | UnifiedTicketingCollectionOutput[] {
+        // If the source is not an array, convert it to an array for mapping
+        const sourcesArray = Array.isArray(source) ? source : [source];
+
+        return sourcesArray.map((collection) =>
+            this.mapSingleCollectionToUnified(
+                collection,
+                connectionId,
+                customFieldMappings,
+            ),
+        );
+    }
+
+    private mapSingleCollectionToUnified(
+        collection: GithubCollectionOutput,
+        connectionId: string,
+        customFieldMappings?: {
+            slug: string;
+            remote_id: string;
+        }[],
+    ): UnifiedTicketingCollectionOutput {
+        const unifiedCollection: UnifiedTicketingCollectionOutput = {
+            remote_id: String(collection.id),
+            remote_data: collection,
+            name: collection.name,
+            description: collection.description,
+            collection_type: 'PROJECT',
+        };
+
+        return unifiedCollection;
+    }
+}