@aloma.io/integration-sdk 3.8.15 → 3.8.17

package/build/builder/runtime-context.mjs

@@ -31,7 +31,7 @@ export default class RuntimeContext {
         });
         const configuration = connector.configure().config(data.config || {});
         const resolvers = {};
-        const methods = [...data.methods, '__autocomplete', '__endpoint', '__configQuery', '__default'];
+        const methods = [...data.methods, '__autocomplete', '__endpoint', '__default'];
         methods.forEach((method) => {
             resolvers[method] = async (args) => {
                 if (!methods.includes(method))

package/build/controller/index.d.mts

@@ -1,3 +1,4 @@
+import { ConfigField } from '../index.mjs';
 import Fetcher from '../internal/fetcher/fetcher.mjs';
 import { OAuth } from '../internal/fetcher/oauth-fetcher.mjs';
 export declare abstract class AbstractController {
@@ -24,7 +25,6 @@ export declare abstract class AbstractController {
      * @param isShutdown true if the controller is stopped due to shutdown
      */
     protected stop(isShutdown?: boolean): Promise<void>;
-    protected configQuery(arg: any): Promise<any>;
     /**
      * autocomplete configuration options
      *
@@ -96,12 +96,18 @@ export declare abstract class AbstractController {
      *
      * @param configSchema the schema of the config
      */
-    protected configCheck(configSchema: any): Promise<any>;
+    protected configCheck(configSchema: {
+        [key: string]: ConfigField;
+    }): Promise<void>;
     __endpoint(arg: any): Promise<any | null>;
-    __configQuery(arg: any): Promise<any | null>;
     __autocomplete(arg: any): Promise<any | null>;
     __default(arg: any): Promise<any | null>;
-    __healthCheck(configSchema: any): Promise<any>;
+    __healthCheck(configSchema: {
+        [key: string]: ConfigField;
+    }): Promise<void>;
+    defaultConfigCheck(configSchema: {
+        [key: string]: ConfigField;
+    }): Promise<void>;
     _doStart(config: any, oauth: any, newTask: any, updateTask: any, getClient: any, getBlob: any, getBlobContent: any, createBlob: any): Promise<void>;
     _doStop(isShutdown?: boolean): Promise<void>;
 }

package/build/controller/index.mjs

@@ -20,9 +20,6 @@ export class AbstractController {
      * @param isShutdown true if the controller is stopped due to shutdown
      */
     async stop(isShutdown = false) { }
-    configQuery(arg) {
-        return Promise.resolve({});
-    }
     /**
      * autocomplete configuration options
      *
@@ -103,9 +100,6 @@ export class AbstractController {
     async __endpoint(arg) {
         return this.endpoint(arg);
     }
-    async __configQuery(arg) {
-        return this.configQuery(arg);
-    }
     async __autocomplete(arg) {
         return this.autocomplete(arg);
     }
@@ -113,8 +107,43 @@ export class AbstractController {
         return this.fallback(arg);
     }
     async __healthCheck(configSchema) {
-        await this.healthCheck();
-        await this.configCheck(configSchema);
+        const errors = [];
+        try {
+            await this.healthCheck();
+        }
+        catch (e) {
+            errors.push(e.message);
+        }
+        try {
+            await this.defaultConfigCheck(configSchema);
+        }
+        catch (e) {
+            errors.push(e.message);
+        }
+        try {
+            await this.configCheck(configSchema);
+        }
+        catch (e) {
+            errors.push(e.message);
+        }
+        if (errors.length) {
+            throw new Error(errors.join('\n'));
+        }
+    }
+    async defaultConfigCheck(configSchema) {
+        const config = this.config;
+        const missing = Object.entries(configSchema)
+            .map(([key, field]) => {
+            if (!field)
+                return;
+            if (!field.optional && config[key] == null) {
+                return `${field.name} is required`;
+            }
+        })
+            .filter((what) => !!what);
+        if (missing.length) {
+            throw new Error(missing.join('\n'));
+        }
     }
     async _doStart(config, oauth, newTask, updateTask, getClient, getBlob, getBlobContent, createBlob) {
         this.config = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aloma.io/integration-sdk",
-  "version": "3.8.15",
+  "version": "3.8.17",
   "description": "",
   "author": "aloma.io",
   "license": "Apache-2.0",

package/src/builder/runtime-context.mts

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
-import { AbstractController } from '../controller/index.mjs';
-import { Connector } from '../internal/index.mjs';
+import {AbstractController} from '../controller/index.mjs';
+import {Connector} from '../internal/index.mjs';
 
 export default class RuntimeContext {
   constructor(
@@ -37,7 +37,7 @@ export default class RuntimeContext {
     const configuration = connector.configure().config(data.config || {});
 
     const resolvers: any = {};
-    const methods: string[] = [...data.methods, '__autocomplete', '__endpoint', '__configQuery', '__default'];
+    const methods: string[] = [...data.methods, '__autocomplete', '__endpoint', '__default'];
 
     methods.forEach((method) => {
       resolvers[method] = async (args) => {

package/src/controller/index.mts

@@ -1,5 +1,6 @@
+import {ConfigField} from '../index.mjs';
 import Fetcher from '../internal/fetcher/fetcher.mjs';
-import { OAuth } from '../internal/fetcher/oauth-fetcher.mjs';
+import {OAuth} from '../internal/fetcher/oauth-fetcher.mjs';
 
 export abstract class AbstractController {
   /**
@@ -28,10 +29,6 @@ export abstract class AbstractController {
    */
   protected async stop(isShutdown: boolean = false): Promise<void> {}
 
-  protected configQuery(arg: any): Promise<any> {
-    return Promise.resolve({});
-  }
-
   /**
    * autocomplete configuration options
    *
@@ -144,7 +141,7 @@ export abstract class AbstractController {
    *
    * @param configSchema the schema of the config
    */
-  protected async configCheck(configSchema: any): Promise<any> {
+  protected async configCheck(configSchema: {[key: string]: ConfigField}): Promise<void> {
     // blank, throw an error if the config is not valid
   }
 
@@ -152,10 +149,6 @@ export abstract class AbstractController {
     return this.endpoint(arg);
   }
 
-  async __configQuery(arg: any): Promise<any | null> {
-    return this.configQuery(arg);
-  }
-
   async __autocomplete(arg: any): Promise<any | null> {
     return this.autocomplete(arg);
   }
@@ -164,9 +157,48 @@ export abstract class AbstractController {
     return this.fallback(arg);
   }
 
-  async __healthCheck(configSchema: any): Promise<any> {
-    await this.healthCheck();
-    await this.configCheck(configSchema);
+  async __healthCheck(configSchema: {[key: string]: ConfigField}): Promise<void> {
+    const errors: string[] = [];
+
+    try {
+      await this.healthCheck();
+    } catch (e: any) {
+      errors.push(e.message);
+    }
+
+    try {
+      await this.defaultConfigCheck(configSchema);
+    } catch (e: any) {
+      errors.push(e.message);
+    }
+
+    try {
+      await this.configCheck(configSchema);
+    } catch (e: any) {
+      errors.push(e.message);
+    }
+
+    if (errors.length) {
+      throw new Error(errors.join('\n'));
+    }
+  }
+
+  async defaultConfigCheck(configSchema: {[key: string]: ConfigField}): Promise<void> {
+    const config = this.config;
+
+    const missing = Object.entries(configSchema)
+      .map(([key, field]) => {
+        if (!field) return;
+
+        if (!field.optional && config[key] == null) {
+          return `${field.name} is required`;
+        }
+      })
+      .filter((what) => !!what);
+
+    if (missing.length) {
+      throw new Error(missing.join('\n'));
+    }
   }
 
   async _doStart(

package/src/internal/connector/index.mts

@@ -1,7 +1,7 @@
-import { Dispatcher } from '../dispatcher/index.mjs';
-import { makeConfig } from './config.mjs';
-import { makeMetrics } from './metrics.mjs';
-import { makeServer } from './server/index.mjs';
+import {Dispatcher} from '../dispatcher/index.mjs';
+import {makeConfig} from './config.mjs';
+import {makeMetrics} from './metrics.mjs';
+import {makeServer} from './server/index.mjs';
 
 export class Connector {
   id: any;

package/src/internal/connector/server/on-connect/index.mts

@@ -1,12 +1,12 @@
-import { init } from '@paralleldrive/cuid2';
-import { AbstractController } from '../../../../index.mjs';
+import {init} from '@paralleldrive/cuid2';
+import {AbstractController} from '../../../../index.mjs';
 import Dispatcher from '../../../dispatcher/index.mjs';
 import Fetcher from '../../../fetcher/fetcher.mjs';
-import { Config } from '../../../websocket/config.mjs';
-import { decryptConfig } from './decrypt-config.mjs';
-import { patchFinishOAuth } from './finish-oauth.mjs';
-import { makeOAuth } from './make-oauth.mjs';
-import { patchStartOAuth } from './start-oauth.mjs';
+import {Config} from '../../../websocket/config.mjs';
+import {decryptConfig} from './decrypt-config.mjs';
+import {patchFinishOAuth} from './finish-oauth.mjs';
+import {makeOAuth} from './make-oauth.mjs';
+import {patchStartOAuth} from './start-oauth.mjs';
 
 const cuid = init({length: 32});