feat: add Zendesk ticket integration

Author: Aqil-Ahmad

apps/api-harmonization/src/app.module.ts

@@ -78,7 +78,7 @@ export const AuthModuleBaseModule = AuthModule.Module.register(AppConfig);
 
 @Module({
     imports: [
-        HttpModule,
+        HttpModule.register({ global: true }),
         LoggerModule,
         ConfigModule.forRoot({
             isGlobal: true,

packages/configs/integrations/package.json

@@ -18,7 +18,8 @@
     "dependencies": {
         "@o2s/framework": "*",
         "@o2s/integrations.mocked": "*",
-        "@o2s/integrations.strapi-cms": "*"
+        "@o2s/integrations.strapi-cms": "*",
+        "@o2s/integrations.zendesk": "*"
     },
     "devDependencies": {
         "@o2s/eslint-config": "*",

packages/configs/integrations/src/models/tickets.ts

@@ -1,9 +1,8 @@
-import { Config, Integration } from '@o2s/integrations.mocked/integration';
+import { Config as ZendeskConfig, Integration as ZendeskIntegration } from '@o2s/integrations.zendesk/integration';
 
 import { ApiConfig } from '@o2s/framework/modules';
 
-export const TicketsIntegrationConfig: ApiConfig['integrations']['tickets'] = Config.tickets!;
-
-export import Service = Integration.Tickets.Service;
-export import Request = Integration.Tickets.Request;
-export import Model = Integration.Tickets.Model;
+export const TicketsIntegrationConfig: ApiConfig['integrations']['tickets'] = ZendeskConfig.tickets!;
+export import Service = ZendeskIntegration.Tickets.Service;
+export import Request = ZendeskIntegration.Tickets.Request;
+export import Model = ZendeskIntegration.Tickets.Model;

packages/integrations/zendesk/.gitignore

@@ -0,0 +1,56 @@
+
+# compiled output
+/dist
+/node_modules
+/build
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+
+# temp directory
+.temp
+.tmp
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

packages/integrations/zendesk/.prettierrc.mjs

@@ -0,0 +1,11 @@
+import apiConfig from '@o2s/prettier-config/api.mjs';
+
+/**
+ * @see https://prettier.io/docs/en/configuration.html
+ * @type {import("prettier").Config}
+ */
+const config = {
+    ...apiConfig,
+};
+
+export default config;

packages/integrations/zendesk/eslint.config.mjs

@@ -0,0 +1,4 @@
+import { config } from '@o2s/eslint-config/api';
+
+/** @type {import("eslint").Linter.Config} */
+export default config;

packages/integrations/zendesk/lint-staged.config.mjs

@@ -0,0 +1,4 @@
+export default {
+    '*.{js,jsx,ts,tsx,css,scss}': ['prettier --write'],
+    '*.{js,jsx,ts,tsx}': () => 'tsc --noEmit',
+};

packages/integrations/zendesk/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@o2s/integrations.zendesk",
+  "version": "1.0.0",
+  "private": false,
+  "license": "MIT",
+  "exports": {
+    "./integration": "./dist/integration.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "tsc && (concurrently \"tsc -w\" \"tsc-alias -w\")",
+    "build": "tsc && tsc-alias",
+    "lint": "tsc --noEmit && eslint . --max-warnings 0",
+    "format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,css,scss,json}\""
+  },
+  "dependencies": {
+    "@nestjs/axios": "^3.0.0",
+    "@nestjs/common": "^10.0.0",
+    "@o2s/framework": "*",
+    "@o2s/utils.logger": "*",
+    "axios": "^1.6.0",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@o2s/eslint-config": "*",
+    "@o2s/prettier-config": "*",
+    "@o2s/typescript-config": "*",
+    "concurrently": "^9.2.1",
+    "eslint": "^9.37.0",
+    "prettier": "^3.6.2",
+    "tsc-alias": "^1.8.10",
+    "typescript": "^5.7.3"
+  }
+}

packages/integrations/zendesk/src/integration.ts

@@ -0,0 +1,15 @@
+import { HttpModule } from '@nestjs/axios';
+
+import { ApiConfig, Users } from '@o2s/framework/modules';
+
+import { Service as TicketsService } from './modules/tickets';
+
+export * as Integration from './modules/index';
+
+export const Config: Partial<ApiConfig['integrations']> = {
+    tickets: {
+        name: 'zendesk',
+        service: TicketsService,
+        imports: [HttpModule, Users.Module],
+    },
+};

packages/integrations/zendesk/src/modules/index.ts

@@ -0,0 +1 @@
+export * as Tickets from './tickets';