@aloma.io/integration-sdk 3.3.16 → 3.3.18

package/build/builder/index.d.mts

@@ -5,6 +5,7 @@ export declare class Builder {
     options(arg: any): Builder;
     auth(arg: any): Builder;
     build(): Promise<RuntimeContext>;
+    private checkLogo;
     private parsePackageJson;
     private discoverTypes;
 }

package/build/builder/index.mjs

@@ -28,10 +28,25 @@ export class Builder {
     async build() {
         await this.parsePackageJson();
         await this.discoverTypes();
+        await this.checkLogo();
         // @ts-ignore
         const Controller = (await import(__dirname + "/../../../../../build/controller/index.mjs")).default;
         return new RuntimeContext(new Controller(), this.data);
     }
+    async checkLogo() {
+        const data = this.data;
+        const root = __dirname + "/../../../../../";
+        const logo = ['logo.png'].find((name) => {
+            try {
+                fs.readFileSync(`${root}/${name}`);
+                return `${root}/${name}`;
+            }
+            catch (e) {
+                // blank
+            }
+        });
+        data.logo = logo;
+    }
     async parsePackageJson() {
         const data = this.data;
         const packageJson = JSON.parse(fs.readFileSync(__dirname + "/../../../../../package.json", {

package/build/builder/runtime-context.mjs

@@ -16,6 +16,7 @@ export default class RuntimeContext {
             id: data.id,
             version: data.version,
             name: `${data.id}/${data.version}`,
+            icon: data.icon
         });
         const configuration = connector.configure().config(data.config || {});
         const resolvers = {};

package/build/builder/transform/index.mjs

@@ -30,31 +30,32 @@ const transform = (meta) => {
             if (example) {
                 const parts = example.split(/```/);
                 const backticks = '```';
-                eg = `@example ${parts[0]}\n${backticks}${parts[1]}${backticks}`;
+                eg = `@example ${parts[0] || 'usage'}\n${backticks}${parts[1]}${backticks}`;
             }
             const paramDocs = docs
-                .filter((what) => what.kind === "param")
-                .map((what) => {
-                return ` * @param {${what.value.type}} ${what.value.name} - ${what.value.description || ""}`;
-            })
-                .join("\n") || " *";
+                .filter((what) => what.kind === "param");
             const params = sig
                 .getParameters()
+                .filter((param) => param.isNamed())
                 .map((param) => {
                 const serialized = param.serialize();
-                switch (!!param.isNamed()) {
-                    case true:
-                        const tmp = param
-                            .getNamedElements()
-                            .map((p) => {
-                            const defaultVal = p.default != null ? " = " + p.default : "";
-                            return `${p.name}${defaultVal}`;
-                        })
-                            .join("; ");
-                        return `{${tmp}}: ${serialized.type.text}`;
-                    case false:
-                        return `${serialized.name}: ${serialized.type.text}`;
-                }
+                const prefix = param
+                    .getNamedElements()
+                    .map((p) => {
+                    const defaultVal = p.getDefault() != null ? " = " + p.getDefault() : "";
+                    return `${p.getName()}${defaultVal}`;
+                })
+                    .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, '@');
+                    return `\n/**\n${desc}\n */\n ${p.name}: ${p.type.text}`;
+                })
+                    .join("; ");
+                return `{${prefix}}: {${suffix}}`;
             })
                 .join(", ");
             const retVal = sig
@@ -65,8 +66,6 @@ const transform = (meta) => {
 /**
  * ${desc || ""}
  *
-${paramDocs}
- *
  * ${eg || ''}
  **/    
 declare function ${member.getName()}(${params}): ${retVal};
@@ -79,5 +78,5 @@ declare function ${member.getName()}(${params}): ${retVal};
 };
 export default async (path) => {
     const parsed = await parseFromFiles([path]);
-    return transform(parsed?.result || []);
+    return transform(parsed.project?.getModules() || []);
 };

package/build/cli.mjs

@@ -37,7 +37,8 @@ const extract = ({ target, name, connectorId }) => {
     fs.writeFileSync(`${target}/.gitignore`, `.DS_Store
 node_modules
 build
-.env`);
+.env
+yarn-error.log`);
 };
 const generateKeys = async ({ target }) => {
     const jwe = new JWE({});

package/build/internal/index.d.mts

@@ -1,12 +1,14 @@
 export class Connector {
-    constructor({ version, id, name }: {
+    constructor({ version, id, name, icon }: {
         version: any;
         id: any;
         name: any;
+        icon: any;
     });
     id: any;
     version: any;
     name: any;
+    icon: any;
     configure(): Dispatcher;
     dispatcher: Dispatcher | undefined;
     run(): Promise<void>;

package/build/internal/index.mjs

@@ -184,10 +184,11 @@ class OAuth {
     }
 }
 class Connector {
-    constructor({ version, id, name }) {
+    constructor({ version, id, name, icon }) {
         this.id = id;
         this.version = version;
         this.name = name;
+        this.icon = icon;
     }
     configure() {
         return (this.dispatcher = new Dispatcher());
@@ -229,6 +230,7 @@ class Connector {
             publicKey: process.env.PUBLIC_KEY,
             introspect,
             configSchema,
+            icon
         });
         if (Object.keys(configSchema().fields).length) {
             try {

package/build/internal/websocket/config.d.mts

@@ -1,5 +1,5 @@
 export class Config {
-    constructor({ registrationToken, version, name, id, endpoint, wsEndpoint, privateKey, publicKey, introspect, configSchema, }: {
+    constructor({ registrationToken, version, name, id, endpoint, wsEndpoint, privateKey, publicKey, introspect, configSchema, icon }: {
         registrationToken: any;
         version: any;
         name: any;
@@ -10,6 +10,7 @@ export class Config {
         publicKey: any;
         introspect: any;
         configSchema: any;
+        icon: any;
     });
     _token: any;
     _registrationToken: any;
@@ -24,6 +25,7 @@ export class Config {
     _jwe: JWE;
     _introspect: any;
     _configSchema: any;
+    _icon: any;
     validateKeys(algorithm: any): Promise<JWE>;
     data(what: any): {};
     introspect(): any;
@@ -36,6 +38,7 @@ export class Config {
     wsUrl(): any;
     registrationToken(): any;
     token(): any;
+    icon(): any;
     setToken(what: any): void;
 }
 import JWE from "../util/jwe/index.mjs";

package/build/internal/websocket/config.mjs

@@ -1,7 +1,7 @@
 import C from "./connection/constants.mjs";
 import JWE from "../util/jwe/index.mjs";
 class Config {
-    constructor({ registrationToken, version, name, id, endpoint, wsEndpoint, privateKey, publicKey, introspect, configSchema, }) {
+    constructor({ registrationToken, version, name, id, endpoint, wsEndpoint, privateKey, publicKey, introspect, configSchema, icon }) {
         this._token = null;
         this._registrationToken = registrationToken;
         this._version = version;
@@ -15,6 +15,7 @@ class Config {
         this._jwe = new JWE({});
         this._introspect = introspect;
         this._configSchema = configSchema;
+        this._icon = icon;
         if (!registrationToken)
             throw new Error("empty registration token (set env.REGISTRATION_TOKEN)");
         if (!endpoint)
@@ -70,6 +71,9 @@ class Config {
     token() {
         return this._token;
     }
+    icon() {
+        return this._icon;
+    }
     setToken(what) {
         this._token = what;
     }

package/build/internal/websocket/connection/registration.mjs

@@ -9,6 +9,7 @@ class Registration {
         const config = this.config;
         const configSchema = config.configSchema();
         const intro = await config.introspect();
+        const icon = config.icon();
         const response = await fetch(config.url() + "register", C.augmentRegistration({
             method: "POST",
             body: JSON.stringify({
@@ -18,6 +19,7 @@ class Registration {
                 id: config.id(),
                 publicKey: config.publicKey(),
                 schema: { configSchema, introspect: intro },
+                icon
             }),
             headers: { "Content-Type": "application/json" },
         }, config));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aloma.io/integration-sdk",
-  "version": "3.3.16",
+  "version": "3.3.18",
   "description": "",
   "author": "aloma.io",
   "license": "Apache-2.0",
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@paralleldrive/cuid2": "^2",
-    "@ts-ast-parser/core": "^0.4.0",
+    "@ts-ast-parser/core": "^0.5",
     "@types/node": "^16",
     "commander": "^11",
     "dotenv": "*",

package/src/builder/index.mts

@@ -37,7 +37,8 @@ export class Builder {
   async build(): Promise<RuntimeContext> {
     await this.parsePackageJson();
     await this.discoverTypes();
-
+    await this.checkLogo();
+    
     // @ts-ignore
     const Controller = (
       await import(__dirname + "/../../../../../build/controller/index.mjs")
@@ -45,6 +46,24 @@ export class Builder {
 
     return new RuntimeContext(new Controller(), this.data);
   }
+  
+  private async checkLogo() {
+    const data = this.data;
+    const root = __dirname + "/../../../../../"
+    
+    const logo = ['logo.png'].find((name) => 
+    {
+      try
+      {
+        fs.readFileSync(`${root}/${name}`);
+        return `${root}/${name}`;
+      } catch(e) {
+        // blank
+      }
+    })
+    
+    data.logo = logo;
+  }
 
   private async parsePackageJson() {
     const data = this.data;

package/src/builder/runtime-context.mts

@@ -18,6 +18,7 @@ export default class RuntimeContext {
       id: data.id,
       version: data.version,
       name: `${data.id}/${data.version}`,
+      icon: data.icon
     });
 
     const configuration = connector.configure().config(data.config || {});

package/src/builder/transform/index.mts

@@ -40,41 +40,44 @@ const transform = (meta: any) => {
           {
             const parts = example.split(/```/);
             const backticks = '```';
-            eg = `@example ${parts[0]}\n${backticks}${parts[1]}${backticks}`;
+            eg = `@example ${parts[0] || 'usage'}\n${backticks}${parts[1]}${backticks}`;
           }
           
           const paramDocs =
             docs
               .filter((what: any) => what.kind === "param")
-              .map((what: any) => {
-                return ` * @param {${what.value.type}} ${what.value.name} - ${
-                  what.value.description || ""
-                }`;
-              })
-              .join("\n") || " *";
 
           const params = sig
             .getParameters()
+            .filter((param) => param.isNamed())
             .map((param: any) => {
               const serialized = param.serialize();
-              
-              switch (!!param.isNamed()) {
-                case true:
-                  const tmp = param
-                    .getNamedElements()
-                    .map((p) => {
-                      const defaultVal =
-                        p.default != null ? " = " + p.default : "";
 
-                      return `${p.name}${defaultVal}`;
-                    })
-                    .join("; ");
-                  return `{${tmp}}: ${serialized.type.text}`;
-                case false:
-                  return `${serialized.name}: ${serialized.type.text}`;
-              }
+              const prefix = param
+                .getNamedElements()
+                .map((p) => {
+                  const defaultVal =
+                    p.getDefault() != null ? " = " + p.getDefault() : "";
+
+                  return `${p.getName()}${defaultVal}`;
+                })
+                .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, '@');
+                  
+                  return `\n/**\n${desc}\n */\n ${p.name}: ${p.type.text}`;
+                })
+                .join("; ");
+                
+              return `{${prefix}}: {${suffix}}`;
             })
             .join(", ");
+            
           const retVal = sig
             .serialize()
             .return.type.text.replace(/^Promise</, "")
@@ -84,8 +87,6 @@ const transform = (meta: any) => {
 /**
  * ${desc || ""}
  *
-${paramDocs}
- *
  * ${eg || ''}
  **/    
 declare function ${member.getName()}(${params}): ${retVal};
@@ -100,5 +101,5 @@ declare function ${member.getName()}(${params}): ${retVal};
 
 export default async (path: string) => {
   const parsed = await parseFromFiles([path]);
-  return transform(parsed?.result || []);
+  return transform(parsed.project?.getModules() || []);
 };

package/src/cli.mts

@@ -52,7 +52,8 @@ const extract = ({ target, name, connectorId }) => {
     `.DS_Store
 node_modules
 build
-.env`,
+.env
+yarn-error.log`,
   );
 };
 

package/src/internal/index.mjs

@@ -235,10 +235,11 @@ class OAuth {
 }
 
 class Connector {
-  constructor({ version, id, name }) {
+  constructor({ version, id, name, icon }) {
     this.id = id;
     this.version = version;
     this.name = name;
+    this.icon = icon;
   }
 
   configure() {
@@ -293,6 +294,7 @@ class Connector {
       publicKey: process.env.PUBLIC_KEY,
       introspect,
       configSchema,
+      icon
     });
 
     if (Object.keys(configSchema().fields).length) {

package/src/internal/websocket/config.mjs

@@ -13,6 +13,7 @@ class Config {
     publicKey,
     introspect,
     configSchema,
+    icon
   }) {
     this._token = null;
     this._registrationToken = registrationToken;
@@ -27,6 +28,7 @@ class Config {
     this._jwe = new JWE({});
     this._introspect = introspect;
     this._configSchema = configSchema;
+    this._icon = icon;
 
     if (!registrationToken)
       throw new Error("empty registration token (set env.REGISTRATION_TOKEN)");
@@ -98,6 +100,10 @@ class Config {
   token() {
     return this._token;
   }
+  
+  icon() {
+    return this._icon;
+  }
 
   setToken(what) {
     this._token = what;

package/src/internal/websocket/connection/registration.mjs

@@ -11,6 +11,7 @@ class Registration {
     const config = this.config;
     const configSchema = config.configSchema();
     const intro = await config.introspect();
+    const icon = config.icon();
 
     const response = await fetch(
       config.url() + "register",
@@ -24,6 +25,7 @@ class Registration {
             id: config.id(),
             publicKey: config.publicKey(),
             schema: { configSchema, introspect: intro },
+            icon
           }),
           headers: { "Content-Type": "application/json" },
         },