@aloma.io/integration-sdk 3.0.0-13 → 3.0.0-15

package/README.md

@@ -2,7 +2,7 @@
 
 ## Prerequisites
 
-* You can find the `REGISTRATION_TOKEN` in your aloma workspace in the integration section.
+* You can find the `REGISTRATION_TOKEN` in your aloma workspace in the integration section when adding a connector.
 
 ## Integration Examples
 

package/examples/hello-world/Containerfile

@@ -10,7 +10,7 @@ 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; 
+RUN set -e; apk add --no-cache git; yarn config set --home enableTelemetry 0; chmod 755 /connector/entrypoint.sh; cd /connector/; yarn install;
 
 USER connector
 

package/examples/hello-world/package.json

@@ -3,9 +3,24 @@
   "version": "1.0.0",
   "description": "",
   "author": "aloma.io",
+  "connectorId": "TODO",
   "license": "Apache-2.0",
   "scripts": {},
+  "type": "module",
+  "scripts": {
+    "start": "node build/index.mjs",
+    "dev": "./node_modules/typescript/bin/tsc --watch",
+    "build": "rm -rf build; mkdir -p build/controller; cp ./src/controller/index.mts ./build/controller/.controller-for-types.mts; ./node_modules/typescript/bin/tsc",
+    "test": "./node_modules/mocha/bin/_mocha --recursive",
+    "format": "yarn prettier --write src/"
+  },
   "dependencies": {
-    "@aloma.io/integration-sdk": "^3"
+    "@aloma.io/integration-sdk": "3.0.0-12"
+  },
+  "devDependencies": {
+    "@types/node": "^18",
+    "mocha": "^10",
+    "prettier": "^2",
+    "typescript": "^5"
   }
 }

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

@@ -0,0 +1,13 @@
+import {AbstractController} from '@aloma.io/integration-sdk';
+
+export default class Controller extends AbstractController {
+  private knex: any;
+
+  /**
+   * say hello
+   */
+  async hello(args: any)
+  {
+    return "hello world";
+  }
+}

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

@@ -0,0 +1,6 @@
+import {Builder} from '@aloma.io/integration-sdk';
+
+const builder = new Builder();
+const runtime = await builder.build();
+
+await runtime.start();

package/examples/hello-world/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "es2022",     
+    "skipLibCheck": true,                     
+    "module": "node16",
+    "moduleResolution": "node16",
+    "lib": ["es2015", "es6", "esnext"],           
+    "declaration": true,          
+    "allowJs": true,
+    "outDir": "build",                          
+    "rootDir": "src/",
+    "strict": true,         
+    "noImplicitAny": false,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules/**/*",
+    "dist/**/*"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aloma.io/integration-sdk",
-  "version": "3.0.0-13",
+  "version": "3.0.0-15",
   "description": "",
   "author": "aloma.io",
   "license": "Apache-2.0",
@@ -23,6 +23,7 @@
   },
   "dependencies": {
     "@paralleldrive/cuid2": "^2",
+    "@ts-ast-parser/core": "^0",
     "dotenv": "*",
     "express": "^4",
     "jose": "^4",
@@ -35,7 +36,6 @@
     "utf-8-validate": "^6"
   },
   "devDependencies": {
-    "@ts-ast-parser/core": "^0",
     "@types/node": "^18",
     "mocha": "^10",
     "prettier": "^2",

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

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

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

@@ -1,29 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,54 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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();