@aloma.io/integration-sdk 3.0.0-4 → 3.0.0-5

package/README.md

@@ -0,0 +1,9 @@
+# nodejs - Aloma Integration SDK
+
+## Prerequisites
+
+* You can find the `REGISTRATION_TOKEN` in your aloma workspace in the integration section.
+
+## Integration Examples
+
+See `examples` directory.

package/examples/hello-world/Containerfile

@@ -0,0 +1,17 @@
+FROM node:16-alpine3.18
+
+ENV NODE_ENV production
+
+WORKDIR /connector/
+
+COPY ./package.json ./
+COPY ./entrypoint.sh ./
+COPY ./src ./src
+
+RUN set -e; adduser -S -u 1111 connector
+
+RUN set -e; apk add --no-cache git; yarn config set --home enableTelemetry 0; chmod 755 /connector/entrypoint.sh; cd /connector/; yarn install; rm -rf package.json; rm -rf yarn.lock; 
+
+USER connector
+
+ENTRYPOINT ["/connector/entrypoint.sh"]

package/examples/hello-world/entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/sh -e
+
+cd /connector/
+
+exec node src/index.js $@

package/examples/hello-world/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "hello-world",
+  "version": "1.0.0",
+  "description": "",
+  "author": "aloma.io",
+  "license": "Apache-2.0",
+  "scripts": {},
+  "dependencies": {
+    "@aloma.io/integration-sdk": "^3"
+  }
+}

package/examples/hello-world/src/controller/index.js

@@ -0,0 +1,14 @@
+class Controller
+{
+  setConfig({newTask, config})
+  {
+    // blank
+  }
+  
+  async hello(args)
+  {
+    return "world";
+  }
+}
+
+module.exports = {Controller}

package/examples/hello-world/src/index.js

@@ -0,0 +1,29 @@
+const {Connector}  = require('@aloma-io/integration-sdk');
+const {Controller} = require('./controller');
+
+const connector    = new Connector({id: 'TODO your connector id', version: '1.0.0'});
+const controller   = new Controller();
+
+connector.configure()
+  // types are the calls available in the step, these are typescript definitions
+  .types
+  (`
+    declare function hello(arg: {}): any;
+  `)
+  // resolvers hold the calls
+  .resolvers
+  ({
+    hello: async (args) => 
+    {
+      return controller.hello(args);
+    },
+  })
+  // main will be called once the connector is connected
+  .main(({newTask, config}) =>
+  {
+    // the config might have changed, so the connector should be able to deal with multiple setConfigs over it's lifetime
+    controller.setConfig({newTask, config});
+  });  
+
+// start the connector
+connector.run();

package/examples/kitchen-sink/01-hello-world.js

@@ -0,0 +1,26 @@
+const {Connector}  = require('@aloma-io/integration-sdk');
+
+const connector    = new Connector({id: 'TODO your connector id', version: '1.0.0'});
+
+connector.configure()
+  // types are the calls available in the step, these are typescript definitions
+  .types
+  (`
+    declare function hello(arg: {}): any;
+  `)
+  // resolvers hold the calls
+  .resolvers
+  ({
+    hello: async (args) => 
+    {
+      return "world";
+    },
+  })
+  // main will be called once the connector is connected
+  .main(({newTask, config}) =>
+  {
+    // the config might have changed, so the connector should be able to deal with multiple setConfigs over it's lifetime
+  });  
+
+// start the connector
+connector.run();

package/examples/kitchen-sink/02-config.js

@@ -0,0 +1,54 @@
+const {Connector}  = require('@aloma-io/integration-sdk');
+
+const connector    = new Connector({id: 'TODO your connector id', version: '1.0.0'});
+
+connector.configure()
+  // these config fields can be configured from the aloma ui. these require a private and a public key which the connector will generate on start
+  .config({fields: 
+  {
+    // this is then available from config.type
+    type: {
+      // name and placeholder for ui configuration
+      name: 'Database Type',
+      placeholder: 'e.g. mysql, pg, tedious',
+      // type
+      type: 'line',
+      // this is an unencrypted value, by default everything is encrypted
+      plain: true
+    },
+    user: {
+      name: 'User',
+      placeholder: 'e.g. john',
+      type: 'line',
+      plain: true,
+      // this is marked as optional in the ui, so does not have to be provided, everything else is mandatory
+      optional: true
+    },
+    // this is encrypted in the ui via public key, can only be decrypted by the connector having the private key
+    password: {
+      name: 'Password',
+      placeholder: 'e.g. x3gsadg',
+      type: 'line',
+      optional: true
+    },
+ 
+  }})
+  .types
+  (`
+    declare function hello(arg: {}): any;
+  `)
+  .resolvers
+  ({
+    hello: async (args) => 
+    {
+      return "world";
+    },
+  })
+  .main(({newTask, config}) =>
+  {
+    console.log(config.type)
+    console.log(config.password)
+    console.log(config.user)
+  });  
+
+connector.run();

package/examples/kitchen-sink/03-oauth.js

@@ -0,0 +1,36 @@
+const {Connector}  = require('@aloma-io/integration-sdk');
+
+const connector    = new Connector({id: 'TODO your connector id', version: '1.0.0'});
+
+connector.configure()
+  // these require a private and a public key which the connector will generate on start
+  // after a connector is added to a workspace it can be connected from the aloma ui
+  .oauth
+  ({
+    // the authorization url, the placeholders {{clientId}}, {{redirectURI}}, {{scope}} will be filled in by aloma
+    authorizationURL: 'https://github.com/login/oauth/authorize?client_id={{clientId}}&redirect_uri={{redirectURI}}&scope={{scope}}&allow_signup=false',
+    tokenURL: 'https://github.com/login/oauth/access_token',
+    clientId: 'clientId',
+    clientSecret: 'clientSecret',
+    scope: 'repo, user:email'
+  })
+  .types
+  (`
+    declare function hello(arg: {}): any;
+  `)
+  .resolvers
+  ({
+    hello: async (args) => 
+    {
+      return "world";
+    },
+  })
+  .main(({newTask, config, oauth}) =>
+  {
+    // one can access oauth.accessToken()
+    // one can get a fetch client: oauth.getClient()
+    // the client supports retries and will also do an automatic token refresh if a refresh_token is provided
+    // oauth.getClient().fetch({url, options = {method: 'POST', headers: {}, body: ''})
+  });  
+
+connector.run();

package/index.js

@@ -0,0 +1,3 @@
+const {Connector} = require('./src/')
+
+module.exports = {Connector}

package/package.json

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