@aloma.io/integration-sdk 3.8.11 → 3.8.12

package/build/transform/index.mjs

@@ -1,19 +1,19 @@
-import { parseFromFiles } from "@ts-ast-parser/core";
+import { parseFromFiles } from '@ts-ast-parser/core';
 const transform = (meta) => {
     if (!meta?.length)
-        throw new Error("metadata is empty");
+        throw new Error('metadata is empty');
     meta = meta[0];
     if (meta.getDeclarations()?.length !== 1) {
-        throw new Error("connector file needs to export default class");
+        throw new Error('connector file needs to export default class');
     }
     const methods = {};
     const decl = meta.getDeclarations()[0];
     const members = decl.getMethods().filter((member) => {
         return !(member.isStatic() ||
             member.isInherited() ||
-            member.getKind() !== "Method" ||
-            member.getModifier() !== "public" ||
-            member.getName().startsWith("_"));
+            member.getKind() !== 'Method' ||
+            member.getModifier() !== 'public' ||
+            member.getName().startsWith('_'));
     });
     const text = members
         .map((member) => {
@@ -22,17 +22,17 @@ const transform = (meta) => {
             .getSignatures()
             .map((sig) => {
             const docs = sig.getJSDoc().serialize() || [];
-            const desc = docs.find((what) => what.kind === "description")?.value;
-            const example = docs.find((what) => what.kind === "example")?.value;
-            const ns = docs.find((what) => what.kind === "namespace")?.value;
-            let space = ns ? `@namespace ${ns}` : "";
+            const desc = docs.find((what) => what.kind === 'description')?.value;
+            const example = docs.find((what) => what.kind === 'example')?.value;
+            const ns = docs.find((what) => what.kind === 'namespace')?.value;
+            let space = ns ? `@namespace ${ns}` : '';
             let eg;
             if (example) {
                 const parts = example.split(/```/);
-                const backticks = "```";
-                eg = `@example ${parts[0] || "usage"}\n${backticks}${parts[1]}${backticks}`;
+                const backticks = '```';
+                eg = `@example ${parts[0] || 'usage'}\n${backticks}${parts[1]}${backticks}`;
             }
-            const paramDocs = docs.filter((what) => what.kind === "param");
+            const paramDocs = docs.filter((what) => what.kind === 'param');
             const params = sig
                 .getParameters()
                 .filter((param) => param.isNamed())
@@ -41,42 +41,42 @@ const transform = (meta) => {
                 const prefix = param
                     .getNamedElements()
                     .map((p) => {
-                    const defaultVal = p.getDefault() != null ? " = " + p.getDefault() : "";
+                    const defaultVal = p.getDefault() != null ? ' = ' + p.getDefault() : '';
                     return `${p.getName()}${defaultVal}`;
                 })
-                    .join("; ");
+                    .join('; ');
                 const suffix = serialized.type.properties
                     .map((p) => {
                     const comment = paramDocs.find((what) => what.value.name === p.name);
-                    const desc = (comment?.value.description || "").replace(/\\@/gi, "@");
+                    const desc = (comment?.value.description || '').replace(/\\@/gi, '@');
                     return `\n/**\n${desc}\n */\n ${p.name}: ${p.type.text}`;
                 })
-                    .join("; ");
+                    .join('; ');
                 return `{${prefix}}: {${suffix}}`;
             })
-                .join(", ");
+                .join(', ');
             const retVal = sig
                 .serialize()
-                .return.type.text.replace(/^Promise</, "")
-                .replace(/>$/, "");
+                .return.type.text.replace(/^Promise</, '')
+                .replace(/>$/, '');
             return `
 /**
- * ${desc || ""}
+ * ${desc || ''}
  *
- * ${space || ""}
- * ${eg || ""}
+ * ${space || ''}
+ * ${eg || ''}
  **/    
 declare function ${member.getName()}(${params}): ${retVal};
       `;
         })
-            .join("\n");
+            .join('\n');
     })
-        .join("");
+        .join('');
     return { text, methods: Object.keys(methods) };
 };
 export default async (path) => {
     const parsed = await parseFromFiles([path]);
     if (parsed.errors?.length)
-        throw new Error(path + " " + JSON.stringify(parsed.errors));
+        throw new Error(path + ' ' + JSON.stringify(parsed.errors));
     return transform(parsed.project?.getModules() || []);
 };

package/package.json

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

package/src/builder/index.mts

@@ -1,11 +1,11 @@
-import "dotenv/config";
-import fs from "node:fs";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import { notEmpty } from "../internal/util/index.mjs";
-import RuntimeContext from "./runtime-context.mjs";
+import 'dotenv/config';
+import fs from 'node:fs';
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {notEmpty} from '../internal/util/index.mjs';
+import RuntimeContext from './runtime-context.mjs';
 
-const DIR_OFFSET = "/../../../../../";
+const DIR_OFFSET = '/../../../../../';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -14,50 +14,51 @@ export const TARGET_DIR = `${__dirname}${DIR_OFFSET}`;
 /**
  * a configuration field
  */
-export type ConfigField = {
-  /**
-   * the name of the field
-   */
-  name: string;
-  /**
-   * a description about the field
-   *
-   * supports markdown
-   */
-  description?: string;
-  /**
-   * a placeholder for the field
-   */
-  placeholder?: string;
-  /**
-   * the type of the field
-   */
-  type:
-  /**
-   * a multiline text field
-   */
-  "multiline"
-  /**
-   * a single line text field
-   */
-  | "line"
-  /**
-   * a number field
-   */
-  | "number"
-  /**
-   * a boolean text field
-   */
-  | "boolean";
-  /**
-   * if true, the field is optional, otherwise a value is required
-   */
-  optional?: boolean;
-  /**
-   * if true, the field will NOT be encrypted
-   */
-  plain?: boolean;
-} | undefined;
+export type ConfigField =
+  | {
+      /**
+       * the name of the field
+       */
+      name: string;
+      /**
+       * a description about the field
+       *
+       * supports markdown
+       */
+      description?: string;
+      /**
+       * a placeholder for the field
+       */
+      placeholder?: string;
+      /**
+       * the type of the field
+       */
+      type: /**
+       * a multiline text field
+       */
+      | 'multiline'
+        /**
+         * a single line text field
+         */
+        | 'line'
+        /**
+         * a number field
+         */
+        | 'number'
+        /**
+         * a boolean text field
+         */
+        | 'boolean';
+      /**
+       * if true, the field is optional, otherwise a value is required
+       */
+      optional?: boolean;
+      /**
+       * if true, the field will NOT be encrypted
+       */
+      plain?: boolean;
+    }
+  | undefined;
 
 /**
  * connector configuration
@@ -83,7 +84,7 @@ declare type Config = {
     scope?: ConfigField;
     clientId?: ConfigField;
     clientSecret?: ConfigField;
-    [key: string]: ConfigField
+    [key: string]: ConfigField;
   };
 };
 
@@ -98,11 +99,11 @@ declare type Options = {
     /**
      * if the endpoint is enabled
      */
-    enabled: boolean,
+    enabled: boolean;
     /**
      * if true, the endpoint is required to operate the connector and not visible in the ui
      */
-    required?: boolean
+    required?: boolean;
   };
 };
 
@@ -145,7 +146,7 @@ declare type OAuth = {
   /**
    * milliseconds to automatically refresh the token, if a refresh_token is available
    *
-  * @default 4 * 60 * 60 * 1000 // 4 hours
+   * @default 4 * 60 * 60 * 1000 // 4 hours
    */
   tokenRefreshPeriod?: number;
 
@@ -161,8 +162,8 @@ declare type OAuth = {
     /**
      * oauth2 grant type
      */
-    grant_type?: string
-  }
+    grant_type?: string;
+  };
 };
 
 /**
@@ -170,7 +171,7 @@ declare type OAuth = {
  */
 export class Builder {
   private data: any = {
-    controller: "./build/.controller.json",
+    controller: './build/.controller.json',
   };
 
   /**
@@ -214,8 +215,7 @@ export class Builder {
     await this.checkIcon();
 
     // @ts-ignore
-    const Controller = (await import(TARGET_DIR + "build/controller/index.mjs"))
-      .default;
+    const Controller = (await import(TARGET_DIR + 'build/controller/index.mjs')).default;
 
     return new RuntimeContext(new Controller(), this.data);
   }
@@ -223,21 +223,21 @@ export class Builder {
   private async checkIcon() {
     const data = this.data;
 
-    data.icon = TARGET_DIR + "build/logo.png";
+    data.icon = TARGET_DIR + 'build/logo.png';
   }
 
   private async loadDescriptor() {
-    notEmpty(this.data.controller, "controller");
+    notEmpty(this.data.controller, 'controller');
 
     const content = fs.readFileSync(this.data.controller, {
-      encoding: "utf-8",
+      encoding: 'utf-8',
     });
-    const { text, methods, connectorId, version } = JSON.parse(content);
+    const {text, methods, connectorId, version} = JSON.parse(content);
 
     this.data.types = text;
     this.data.methods = methods;
 
-    notEmpty((this.data.id = connectorId), "id");
-    notEmpty((this.data.version = version), "version");
+    notEmpty((this.data.id = connectorId), 'id');
+    notEmpty((this.data.version = version), 'version');
   }
 }

package/src/builder/runtime-context.mts

@@ -1,18 +1,18 @@
-import fs from "node:fs";
-import { AbstractController } from "../controller/index.mjs";
-import { Connector } from "../internal/index.mjs";
+import fs from 'node:fs';
+import { AbstractController } from '../controller/index.mjs';
+import { Connector } from '../internal/index.mjs';
 
 export default class RuntimeContext {
   constructor(
     private controller: AbstractController,
-    private data: any,
+    private data: any
   ) {}
 
   async start(): Promise<void> {
     const controller = this.controller;
 
     if (!(controller instanceof AbstractController)) {
-      throw new Error("the controller needs to extend AbstractController");
+      throw new Error('the controller needs to extend AbstractController');
     }
 
     const data: any = this.data;
@@ -21,7 +21,7 @@ export default class RuntimeContext {
 
     try {
       if (data.icon) {
-        icon = fs.readFileSync(data.icon).toString("base64");
+        icon = fs.readFileSync(data.icon).toString('base64');
       }
     } catch (e) {
       // blank
@@ -37,13 +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', '__configQuery', '__default'];
 
     methods.forEach((method) => {
       resolvers[method] = async (args) => {
@@ -56,10 +50,7 @@ export default class RuntimeContext {
     configuration.types(data.types).resolvers(resolvers);
 
     if (data.options?.endpoint?.enabled) {
-      configuration.endpoint(
-        (arg) => controller.__endpoint(arg),
-        data.options?.endpoint?.required,
-      );
+      configuration.endpoint((arg) => controller.__endpoint(arg), data.options?.endpoint?.required);
     }
 
     if (data.auth?.oauth) {
@@ -69,37 +60,20 @@ export default class RuntimeContext {
     let healthInterval;
 
     configuration.main(
-      async ({
-        newTask,
-        updateTask,
-        config,
-        oauth,
-        getClient,
-        getBlob,
-        getBlobContent,
-        createBlob,
-        healthCheck,
-      }) => {
+      async ({newTask, updateTask, config, oauth, getClient, getBlob, getBlobContent, createBlob, healthCheck}) => {
         try {
           clearInterval(healthInterval);
 
           await controller._doStop();
-          await controller._doStart(
-            config,
-            oauth,
-            newTask,
-            updateTask,
-            getClient,
-            getBlob,
-            getBlobContent,
-            createBlob,
-          );
-
-          healthInterval = setInterval(() => healthCheck(controller), 30000);
+          await controller._doStart(config, oauth, newTask, updateTask, getClient, getBlob, getBlobContent, createBlob);
+
+          healthInterval = setInterval(() => healthCheck(controller), 30000).unref();
+
+          await healthCheck(controller);
         } catch (e) {
           console.log(e);
         }
-      },
+      }
     );
 
     connector.run();
@@ -111,7 +85,7 @@ export default class RuntimeContext {
       process.exit(0);
     };
 
-    process.on("SIGTERM", term);
-    process.on("SIGINT", term);
+    process.on('SIGTERM', term);
+    process.on('SIGINT', term);
   }
 }

package/src/cli.mts

@@ -1,50 +1,48 @@
 #!/usr/bin/env node
 
-import { Command } from "commander";
-import ChildProcess from "node:child_process";
-import fs from "node:fs";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import util from "node:util";
-import { TARGET_DIR } from "./builder/index.mjs";
-import { notEmpty } from "./internal/util/index.mjs";
-import JWE from "./internal/util/jwe/index.mjs";
-import parseTypes from "./transform/index.mjs";
+import {Command} from 'commander';
+import ChildProcess from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import util from 'node:util';
+import {TARGET_DIR} from './builder/index.mjs';
+import {notEmpty} from './internal/util/index.mjs';
+import JWE from './internal/util/jwe/index.mjs';
+import parseTypes from './transform/index.mjs';
 
 const exec = util.promisify(ChildProcess.exec);
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 const files = [
-  { name: "index.mts", dir: "src/controller" },
-  { name: "index.mts", dir: "src" },
-  { name: "package.json", dir: "" },
-  { name: "Containerfile", dir: "" },
-  { name: "entrypoint.sh", dir: "" },
-  { name: "tsconfig.json", dir: "" },
+  {name: 'index.mts', dir: 'src/controller'},
+  {name: 'index.mts', dir: 'src'},
+  {name: 'package.json', dir: ''},
+  {name: 'Containerfile', dir: ''},
+  {name: 'entrypoint.sh', dir: ''},
+  {name: 'tsconfig.json', dir: ''},
 ];
 
-const extract = ({ target, name, connectorId }) => {
+const extract = ({target, name, connectorId}) => {
   const source = `${__dirname}/../template/connector/`;
 
   if (!fs.existsSync(source)) {
     throw new Error(`source ${source} does not exist`);
   }
 
-  files.forEach(({ name, dir }) => {
+  files.forEach(({name, dir}) => {
     if (dir) {
-      fs.mkdirSync(`${target}/${dir}`, { recursive: true });
+      fs.mkdirSync(`${target}/${dir}`, {recursive: true});
     }
 
     const content = fs.readFileSync(`${source}/${dir}/${name}`, {
-      encoding: "utf-8",
+      encoding: 'utf-8',
     });
     fs.writeFileSync(`${target}/${dir}/${name}`, content);
   });
 
-  const content = JSON.parse(
-    fs.readFileSync(`${target}/package.json`, { encoding: "utf-8" }),
-  );
+  const content = JSON.parse(fs.readFileSync(`${target}/package.json`, {encoding: 'utf-8'}));
 
   content.name = name;
   content.connectorId = connectorId;
@@ -56,11 +54,11 @@ const extract = ({ target, name, connectorId }) => {
 node_modules
 build
 .env
-yarn-error.log`,
+yarn-error.log`
   );
 };
 
-const generateKeys = async ({ target }) => {
+const generateKeys = async ({target}) => {
   const jwe = new JWE({});
   await jwe.newPair();
 
@@ -78,34 +76,34 @@ PUBLIC_KEY=${pub}
 const program = new Command();
 
 program
-  .name("npx @aloma.io/integration-sdk")
-  .description("aloma.io integration sdk")
-  .version("0.8.0")
+  .name('npx @aloma.io/integration-sdk')
+  .description('aloma.io integration sdk')
+  .version('0.8.0')
   .showHelpAfterError();
 
 program
-  .command("create")
-  .description("Create a new connector project")
-  .argument("<name>", "name of the project")
-  .requiredOption("--connector-id <id>", "id of the connector")
+  .command('create')
+  .description('Create a new connector project')
+  .argument('<name>', 'name of the project')
+  .requiredOption('--connector-id <id>', 'id of the connector')
   .action(async (name, options) => {
-    name = name.replace(/[\/\.]/gi, "");
-    if (!name) throw new Error("name is empty");
+    name = name.replace(/[\/\.]/gi, '');
+    if (!name) throw new Error('name is empty');
 
     const target = `${process.cwd()}/${name}`;
 
     fs.mkdirSync(target);
 
-    console.log("Creating connector ...");
-    extract({ ...options, target, name });
+    console.log('Creating connector ...');
+    extract({...options, target, name});
 
-    console.log("Generating keys ...");
-    await generateKeys({ target });
+    console.log('Generating keys ...');
+    await generateKeys({target});
 
-    console.log("Installing dependencies ...");
+    console.log('Installing dependencies ...');
     await exec(`cd ${target}; yarn`);
 
-    console.log("Building ...");
+    console.log('Building ...');
     await exec(`cd ${target}; yarn build`);
 
     console.log(`
@@ -117,10 +115,10 @@ Success!
   });
 
 program
-  .command("build")
-  .description("Build the current connector project")
+  .command('build')
+  .description('Build the current connector project')
   .action(async (str, options) => {
-    const { stdout, stderr } = await exec(`rm -rf build; mkdir -p build; `);
+    const {stdout, stderr} = await exec(`rm -rf build; mkdir -p build; `);
 
     try {
       fs.copyFileSync(`${TARGET_DIR}/logo.png`, `${TARGET_DIR}/build/logo.png`);
@@ -130,23 +128,20 @@ program
 
     if (stdout) console.log(stdout);
 
-    new Extractor().extract(
-      "./src/controller/index.mts",
-      "./build/.controller.json",
-    );
+    new Extractor().extract('./src/controller/index.mts', './build/.controller.json');
   });
 
 class Extractor {
   async extract(source, target) {
-    notEmpty(source, "source");
+    notEmpty(source, 'source');
 
     fs.readFileSync(source);
-    const { text, methods } = await parseTypes(source);
+    const {text, methods} = await parseTypes(source);
 
     const packageJson = JSON.parse(
-      fs.readFileSync(TARGET_DIR + "package.json", {
-        encoding: "utf-8",
-      }),
+      fs.readFileSync(TARGET_DIR + 'package.json', {
+        encoding: 'utf-8',
+      })
     );
 
     fs.writeFileSync(
@@ -157,7 +152,7 @@ class Extractor {
         connectorId: packageJson.connectorId,
         version: packageJson.version,
       }),
-      { encoding: "utf-8" },
+      {encoding: 'utf-8'}
     );
   }
 }