feat: support integrations without schema

Author: marian2js

libs/definitions/src/base-integration.definition.ts

@@ -0,0 +1,26 @@
+import { SingleIntegrationData } from './definition'
+import { SingleIntegrationDefinition } from './single-integration.definition'
+import { IntegrationAuthDefinition } from './types/IntegrationAuthDefinition'
+
+export abstract class BaseIntegrationDefinition extends SingleIntegrationDefinition {
+  abstract title: string
+  abstract logo: string
+  categories: string[] = []
+
+  getIntegrationsData(): Promise<SingleIntegrationData[]> | SingleIntegrationData[] {
+    return [
+      {
+        parentKey: this.parentKey,
+        integrationKey: this.integrationKey,
+        integrationVersion: this.integrationVersion,
+        schemaUrl: this.schemaUrl,
+        noSchemaFile: true,
+      },
+    ]
+  }
+
+  // TODO: support auth without schema
+  protected async getAuthDefinition(): Promise<IntegrationAuthDefinition | null> {
+    return null
+  }
+}

libs/definitions/src/definition.ts

@@ -32,6 +32,7 @@ export interface SingleIntegrationData {
   schemaUrl: string | null
   deprecated?: boolean
   metadata?: any
+  noSchemaFile?: boolean
 }
 
 export interface RequestInterceptorOptions {

libs/definitions/src/integration-definitions/graphql/graphql.definition.ts

@@ -1,11 +1,13 @@
-import { SingleIntegrationDefinition } from '@app/definitions/single-integration.definition'
+import { BaseIntegrationDefinition } from '@app/definitions/base-integration.definition'
 import { GraphQLRequestAction } from './actions/graphql-request.action'
 import { NewItemInGraphqlQueryTrigger } from './trigger/new-item-in-graphql-query.trigger'
 
-export class GraphqlDefinition extends SingleIntegrationDefinition {
+export class GraphqlDefinition extends BaseIntegrationDefinition {
+  title = 'GraphQL'
+  logo = 'https://raw.githubusercontent.com/chainjet/assets/master/integrations/graphql.svg'
   integrationKey = 'graphql'
   integrationVersion = '1'
-  schemaUrl = null
+  categories = ['popular', 'chainjet']
 
   triggers = [new NewItemInGraphqlQueryTrigger()]
   actions = [new GraphQLRequestAction()]

libs/definitions/src/integration-definitions/mailchain/mailchain.definition.ts

@@ -13,7 +13,7 @@ export class MailChainDefinition extends SingleIntegrationDefinition {
   actions = [new SendEmailAction()]
 
   async createOrUpdateIntegrationAccount(schema: OpenAPIObject): Promise<IntegrationAccount | null> {
-    const authDefinition = await this._getAuthDefinition()
+    const authDefinition = await this.getAuthDefinition()
     if (!authDefinition) {
       return null
     }

libs/definitions/src/services/integration-installer.service.ts

@@ -12,6 +12,7 @@ import { IntegrationService } from '../../../../apps/api/src/integrations/servic
 import { getItemSchemaFromRes } from '../../../../apps/runner/src/utils/trigger.utils'
 import { decycle, retrocycle } from '../../../common/src/utils/json.utils'
 import { addEllipsis, stripMarkdown, stripMarkdownSync } from '../../../common/src/utils/string.utils'
+import { BaseIntegrationDefinition } from '../base-integration.definition'
 import {
   dereferenceJsonSchema,
   prepareInputsJsonSchema,
@@ -26,11 +27,7 @@ import { SchemaUtils } from '../schema/utils/schema.utils'
 export class IntegrationInstallerService {
   private readonly logger = new Logger(IntegrationInstallerService.name)
 
-  constructor(
-    private readonly integrationService: IntegrationService,
-    private readonly integrationTriggerService: IntegrationTriggerService,
-    private readonly integrationActionService: IntegrationActionService,
-  ) {}
+  constructor() {}
 
   /**
    * Creates or updates integration(s), integration account(s) and integration operations
@@ -285,7 +282,26 @@ export class IntegrationInstallerService {
   ): Promise<OpenAPIObject | null> {
     const schemaUrl = fetchSchemas ? integrationData.schemaUrl : null
 
-    const { integrationKey, integrationVersion } = integrationData
+    const { integrationKey, integrationVersion, noSchemaFile } = integrationData
+
+    if (noSchemaFile) {
+      const baseDefinition = definition as BaseIntegrationDefinition
+      if (!baseDefinition.title) {
+        throw new Error('Missing integration title')
+      }
+      return {
+        openapi: '3.0.0',
+        info: {
+          title: baseDefinition.title,
+          version: '1',
+          'x-categories': baseDefinition.categories,
+          'x-logo': {
+            url: baseDefinition.logo,
+          },
+        },
+        paths: {},
+      }
+    }
 
     let schema = await SchemaUtils.getSchema({
       integrationKey,

libs/definitions/src/single-integration.definition.ts

@@ -33,7 +33,7 @@ export abstract class SingleIntegrationDefinition extends Definition {
   }
 
   async createOrUpdateIntegrationAccount(schema: OpenAPIObject): Promise<IntegrationAccount | null> {
-    const authDefinition = await this._getAuthDefinition()
+    const authDefinition = await this.getAuthDefinition()
     if (!authDefinition) {
       return null
     }
@@ -47,7 +47,7 @@ export abstract class SingleIntegrationDefinition extends Definition {
     })
   }
 
-  async _getAuthDefinition(): Promise<IntegrationAuthDefinition | null> {
+  protected async getAuthDefinition(): Promise<IntegrationAuthDefinition | null> {
     const integrationSchema = await SchemaUtils.getSchema({
       integrationKey: this.integrationKey,
       integrationVersion: this.integrationVersion,