@aloma.io/integration-sdk 3.8.13 → 3.8.15

package/build/controller/index.d.mts

@@ -90,11 +90,18 @@ export declare abstract class AbstractController {
      * throw an error if unhealthy with a message describing what needs to be fixed
      */
     protected healthCheck(): Promise<any>;
+    /**
+     * config check, will be called periodically
+     * throw an error if the config is not valid
+     *
+     * @param configSchema the schema of the config
+     */
+    protected configCheck(configSchema: any): Promise<any>;
     __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(): Promise<any>;
+    __healthCheck(configSchema: any): Promise<any>;
     _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

@@ -91,6 +91,15 @@ export class AbstractController {
     async healthCheck() {
         // blank, throw an error if unhealthy
     }
+    /**
+     * config check, will be called periodically
+     * throw an error if the config is not valid
+     *
+     * @param configSchema the schema of the config
+     */
+    async configCheck(configSchema) {
+        // blank, throw an error if the config is not valid
+    }
     async __endpoint(arg) {
         return this.endpoint(arg);
     }
@@ -103,8 +112,9 @@ export class AbstractController {
     async __default(arg) {
         return this.fallback(arg);
     }
-    async __healthCheck() {
-        return this.healthCheck();
+    async __healthCheck(configSchema) {
+        await this.healthCheck();
+        await this.configCheck(configSchema);
     }
     async _doStart(config, oauth, newTask, updateTask, getClient, getBlob, getBlobContent, createBlob) {
         this.config = config;

package/build/internal/connector/server/on-connect/index.mjs

@@ -62,7 +62,7 @@ export const onConnect = ({ dispatcher, configSchema, config, start, }) => {
                         if (oauthClient) {
                             await oauthClient.__healthCheck();
                         }
-                        await controller.__healthCheck();
+                        await controller.__healthCheck(configSchema);
                     }
                     catch (e) {
                         result.ok = false;

package/package.json

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

package/src/controller/index.mts

@@ -138,6 +138,16 @@ export abstract class AbstractController {
     // blank, throw an error if unhealthy
   }
 
+  /**
+   * config check, will be called periodically
+   * throw an error if the config is not valid
+   *
+   * @param configSchema the schema of the config
+   */
+  protected async configCheck(configSchema: any): Promise<any> {
+    // blank, throw an error if the config is not valid
+  }
+
   async __endpoint(arg: any): Promise<any | null> {
     return this.endpoint(arg);
   }
@@ -154,8 +164,9 @@ export abstract class AbstractController {
     return this.fallback(arg);
   }
 
-  async __healthCheck(): Promise<any> {
-    return this.healthCheck();
+  async __healthCheck(configSchema: any): Promise<any> {
+    await this.healthCheck();
+    await this.configCheck(configSchema);
   }
 
   async _doStart(

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

@@ -104,7 +104,7 @@ export const onConnect = ({
               await oauthClient.__healthCheck();
             }
 
-            await controller.__healthCheck();
+            await controller.__healthCheck(configSchema);
           } catch (e: any) {
             result.ok = false;
             result.error = e.message;