@unito/integration-cli 0.55.1

package/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) Unito, Inc.
+
+This repository is a component of the Unito Software Development Kit (SDK). By downloading, installing, accessing, or using any part of the Unito SDK, including this repository, you signify your acceptance of and agree to be bound by the terms of the Unito Software Development Kit Agreement found at https://unito.io/sdk-agreement/. If you do not agree to the terms of the Unito Software Development Kit Agreement, you are not authorized to download, install, access, or use any part of the Unito SDK, including this repository.

package/README.md

@@ -0,0 +1,32 @@
+# The Integration CLI
+
+The Integration CLI is a command-line tool to build, debug, test and deploy integrations.
+
+As a developer, this CLI will also help you scaffold items & fields faster!
+
+# Usage
+
+```sh
+integration-cli --help
+
+USAGE
+  $ integration-cli [COMMAND]
+
+COMMANDS
+  activity  Show the activity associated with your integration
+  dev       Develop your integration
+  encrypt   Encrypt data
+  init      Initialize a new integration
+  invite    Invite a user to become a developer of your integration
+  login     Login to the Integrations Platform
+  oauth2    Perform an OAuth2 workflow locally
+  publish   Publish your integration
+  test      Test your integration
+  upgrade   Upgrade the CLI
+```
+
+## Terms and Conditions
+
+By using the Integration Debugger, you agree to be bound by our terms and conditions.
+Please ensure you have read and understood the Unito Software Development Kit Agreement before using the API.
+The full agreement can be found at [Unito SDK Agreement](https://unito.io/sdk-agreement/).

package/bin/run

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+// Silence warnings messages (ex: ExperimentalWarning).
+process.removeAllListeners('warning')
+
+const oclif = require('@oclif/core')
+
+process.env.NODE_ENV = 'production';
+process.env.NODE_MODULES_FOLDER = `${__dirname}/../node_modules`;
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/.eslintrc.d.ts

@@ -0,0 +1,10 @@
+export declare namespace env {
+    let node: boolean;
+}
+export declare let plugins: string[];
+declare let _extends: string[];
+export { _extends as extends };
+export declare let rules: {
+    'no-console': string;
+};
+export declare let ignorePatterns: string[];

package/dist/.eslintrc.js

@@ -0,0 +1,20 @@
+"use strict";
+module.exports = {
+    env: {
+        node: true
+    },
+    plugins: [
+        '@typescript-eslint',
+    ],
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+    ],
+    rules: {
+        'no-console': 'off',
+    },
+    ignorePatterns: [
+        'integrationGenerator/integrationBoilerplate',
+        'integrationGenerator/templates',
+    ],
+};

package/dist/integrationGenerator/errors.d.ts

@@ -0,0 +1,2 @@
+export declare class AlreadyExistingIntegrationError extends Error {
+}

package/dist/integrationGenerator/errors.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlreadyExistingIntegrationError = void 0;
+class AlreadyExistingIntegrationError extends Error {
+}
+exports.AlreadyExistingIntegrationError = AlreadyExistingIntegrationError;

package/dist/integrationGenerator/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src';
+export * from './errors';

package/dist/integrationGenerator/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./src"), exports);
+tslib_1.__exportStar(require("./errors"), exports);

package/dist/integrationGenerator/integrationBoilerplate/.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.eslintrc.js

package/dist/integrationGenerator/integrationBoilerplate/.eslintrc.js

@@ -0,0 +1,74 @@
+module.exports = {
+  'env': {
+    'browser': true,
+    'es6': true,
+    'node': true
+  },
+  'parser': '@typescript-eslint/parser',
+  'parserOptions': {
+    'project': './tsconfig.json',
+  },
+  'plugins': [
+    '@typescript-eslint'
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  ignorePatterns: [
+    'node_modules',
+    'dist',
+    '.eslintrc.js'
+  ],
+  'rules': {
+    '@typescript-eslint/no-loss-of-precision': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/ban-ts-comment': 0,
+    '@typescript-eslint/ban-ts-ignore': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/no-var-requires': 0,
+    '@typescript-eslint/no-floating-promises': 2,
+    '@typescript-eslint/no-unused-vars': 0,
+    // We need null in connectors because in some API, adding null to a field makes the API remove the value to the field
+    '@typescript-eslint/no-non-null-assertion': 0,
+    '@typescript-eslint/prefer-namespace-keyword': 0,
+    '@typescript-eslint/no-namespace': 0,
+    '@typescript-eslint/no-inferrable-types': 0,
+    '@typescript-eslint/naming-convention': [
+      1,
+      {
+        selector: [
+          'classProperty',
+          'objectLiteralProperty',
+          'typeProperty',
+          'classMethod',
+          'objectLiteralMethod',
+          'typeMethod',
+          'accessor',
+          'enumMember'
+        ],
+        format: null,
+        modifiers: ['requiresQuotes']
+      }
+    ],
+    'no-whitespace-before-property': 2,
+    'no-trailing-spaces': 2,
+    'no-extra-boolean-cast': 0,
+    'no-inner-declarations': 0,
+    'no-useless-escape': 0,
+    'no-case-declarations': 0,
+    'space-unary-ops': [2,
+      {
+        'words': true,
+        'nonwords': false,
+      },
+    ],
+    'space-before-function-paren': [2, {
+        'anonymous': 'always',
+        'named': 'never',
+        'asyncArrow': 'always'
+    }],
+    'object-curly-spacing': [2, 'always'],
+    'no-console': 2,
+  }
+};

package/dist/integrationGenerator/integrationBoilerplate/.nvmrc

@@ -0,0 +1 @@
+lts/hydrogen

package/dist/integrationGenerator/integrationBoilerplate/.prettierignore

@@ -0,0 +1 @@
+*.md

package/dist/integrationGenerator/integrationBoilerplate/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 180,
+  "arrowParens": "avoid"
+}

package/dist/integrationGenerator/integrationBoilerplate/.unito.json

@@ -0,0 +1 @@
+{}

package/dist/integrationGenerator/integrationBoilerplate/Dockerfile

@@ -0,0 +1,38 @@
+# syntax = docker/dockerfile:1.2
+
+#
+# Build
+#
+
+FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/node:18-alpine as build
+
+WORKDIR /build
+
+COPY . .
+
+RUN --mount=type=secret,id=npmrc,target=.npmrc npm ci
+
+RUN npm install
+RUN npm run compile
+
+#
+# Runtime
+#
+
+FROM --platform=$TARGETPLATFORM public.ecr.aws/docker/library/node:18-alpine as runtime
+
+WORKDIR /app
+
+COPY --from=build \
+  /build/tsconfig.json \
+  /build/package.json \
+  /build/package-lock.json \
+  /build/dist \
+  .
+
+RUN --mount=type=secret,id=npmrc,target=.npmrc npm ci --omit=dev
+
+RUN npm install --omit=dev
+
+ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
+CMD ["node", "./src/index.js"]

package/dist/integrationGenerator/integrationBoilerplate/README.md

@@ -0,0 +1,21 @@
+# Integration Boilerplate
+
+Integration Boilerplate is a codebase for providing a uniform way to integrate new connector.
+
+## Build Docker image locally
+
+```sh
+cd integration-boilerplate
+docker build -t integration-boilerplate .
+```
+
+Run the docker image
+```sh
+docker run --name mytest1 -d -p 9200:9200 integration-boilerplate
+```
+
+Accessible on http://localhost:9200
+
+## License
+
+Copyright © 2015-present Unito Inc. All Rights Reserved.

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.eslintrc.js

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.eslintrc.js

@@ -0,0 +1,74 @@
+module.exports = {
+  'env': {
+    'browser': true,
+    'es6': true,
+    'node': true
+  },
+  'parser': '@typescript-eslint/parser',
+  'parserOptions': {
+    'project': './tsconfig.json',
+  },
+  'plugins': [
+    '@typescript-eslint'
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  ignorePatterns: [
+    'node_modules',
+    'dist',
+    '.eslintrc.js'
+  ],
+  'rules': {
+    '@typescript-eslint/no-loss-of-precision': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/ban-ts-comment': 0,
+    '@typescript-eslint/ban-ts-ignore': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/no-var-requires': 0,
+    '@typescript-eslint/no-floating-promises': 2,
+    '@typescript-eslint/no-unused-vars': 0,
+    // We need null in connectors because in some API, adding null to a field makes the API remove the value to the field
+    '@typescript-eslint/no-non-null-assertion': 0,
+    '@typescript-eslint/prefer-namespace-keyword': 0,
+    '@typescript-eslint/no-namespace': 0,
+    '@typescript-eslint/no-inferrable-types': 0,
+    '@typescript-eslint/naming-convention': [
+      1,
+      {
+        selector: [
+          'classProperty',
+          'objectLiteralProperty',
+          'typeProperty',
+          'classMethod',
+          'objectLiteralMethod',
+          'typeMethod',
+          'accessor',
+          'enumMember'
+        ],
+        format: null,
+        modifiers: ['requiresQuotes']
+      }
+    ],
+    'no-whitespace-before-property': 2,
+    'no-trailing-spaces': 2,
+    'no-extra-boolean-cast': 0,
+    'no-inner-declarations': 0,
+    'no-useless-escape': 0,
+    'no-case-declarations': 0,
+    'space-unary-ops': [2,
+      {
+        'words': true,
+        'nonwords': false,
+      },
+    ],
+    'space-before-function-paren': [2, {
+        'anonymous': 'always',
+        'named': 'never',
+        'asyncArrow': 'always'
+    }],
+    'object-curly-spacing': [2, 'always'],
+    'no-console': 2,
+  }
+};

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.nvmrc

@@ -0,0 +1 @@
+lts/hydrogen

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.prettierignore

@@ -0,0 +1 @@
+*.md

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 180,
+  "arrowParens": "avoid"
+}

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.unito.json

@@ -0,0 +1 @@
+{}

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/Dockerfile

@@ -0,0 +1,38 @@
+# syntax = docker/dockerfile:1.2
+
+#
+# Build
+#
+
+FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/node:18-alpine as build
+
+WORKDIR /build
+
+COPY . .
+
+RUN --mount=type=secret,id=npmrc,target=.npmrc npm ci
+
+RUN npm install
+RUN npm run compile
+
+#
+# Runtime
+#
+
+FROM --platform=$TARGETPLATFORM public.ecr.aws/docker/library/node:18-alpine as runtime
+
+WORKDIR /app
+
+COPY --from=build \
+  /build/tsconfig.json \
+  /build/package.json \
+  /build/package-lock.json \
+  /build/dist \
+  .
+
+RUN --mount=type=secret,id=npmrc,target=.npmrc npm ci --omit=dev
+
+RUN npm install --omit=dev
+
+ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
+CMD ["node", "./src/index.js"]

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/README.md

@@ -0,0 +1,21 @@
+# Integration Boilerplate
+
+Integration Boilerplate is a codebase for providing a uniform way to integrate new connector.
+
+## Build Docker image locally
+
+```sh
+cd integration-boilerplate
+docker build -t integration-boilerplate .
+```
+
+Run the docker image
+```sh
+docker run --name mytest1 -d -p 9200:9200 integration-boilerplate
+```
+
+Accessible on http://localhost:9200
+
+## License
+
+Copyright © 2015-present Unito Inc. All Rights Reserved.

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "integration-boilerplate",
+  "version": "0.0.1",
+  "description": "Integration Boilerplate",
+  "scripts": {
+    "compile": "tsc",
+    "dev": "nodemon --watch \"src/**\" --ext ts --exec \"node --inspect --no-lazy -r ts-node/register/transpile-only src/index.ts\"",
+    "lint": "eslint --resolve-plugins-relative-to . --fix src --ext .ts && prettier --write src",
+    "ci:audit": "check-audit",
+    "ci:eslint": "eslint --resolve-plugins-relative-to . src --ext .ts",
+    "ci:lint": "npm run ci:prettier && npm run ci:eslint || (echo \"Please run eslint and/or prettier and commit the changes\" && exit 1)",
+    "ci:prettier": "prettier --cache --ignore-unknown --check src",
+    "ci:test": "NODE_ENV=test mocha"
+  },
+  "author": {
+    "name": "Unito",
+    "email": "hello@unito.io"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "license": "LicenseRef-LICENSE",
+  "dependencies": {
+    "@unito/integration-api": "^0.x",
+    "express": "^5.0.0-beta.1",
+    "uuid": "9.x"
+  },
+  "devDependencies": {
+    "@types/express": "4.x",
+    "@types/mocha": "10.x",
+    "@types/node": "18.x",
+    "@types/uuid": "9.x",
+    "@typescript-eslint/eslint-plugin": "5.x",
+    "@typescript-eslint/parser": "5.x",
+    "eslint": "8.x",
+    "mocha": "10.x",
+    "nodemon": "2.x",
+    "npm-audit-resolver": "^3.0.0-RC.0",
+    "prettier": "2.x",
+    "ts-node": "10.x",
+    "typescript": "5.x"
+  }
+}

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/src/index.ts

@@ -0,0 +1,94 @@
+import express from 'express';
+import { Error as APIError } from '@unito/integration-api';
+
+import indexRouter from './routes/index';
+import { extractCredentials } from './middlewares/credentials';
+import { extractCorrelationId } from './middlewares/correlationId';
+import { extractAdditionalLoggingContext } from './middlewares/additionalLoggingContext';
+import { logger } from './logger';
+
+// Express Server initialization
+const app: express.Application = express();
+
+// Parse query strings with https://github.com/ljharb/qs.
+app.set('query parser', 'extended');
+
+app.use(express.json());
+
+// Must be one of the first handlers (to catch all the errors).
+app.use((req: express.Request, res: express.Response, next: express.NextFunction) => {
+  if (req.originalUrl !== '/health') {
+    res.on('finish', function () {
+      const loggerLevel = res.statusCode >= 500 ? 'error' : 'info';
+
+      // eslint-disable-next-line
+      logger[loggerLevel](`${req.method} ${req.originalUrl} ${res.statusCode}`);
+    });
+  }
+
+  next();
+});
+
+// Extract and validate the credentials.
+app.use(extractCredentials);
+
+// Extract the correlation id.
+app.use(extractCorrelationId);
+
+// Load the routes.
+app.use('/', indexRouter);
+
+// Extract the additional logging context.
+app.use(extractAdditionalLoggingContext);
+
+// Must be the (last - 1) handler.
+app.use((err: Error, _req: express.Request, res: express.Response, next: express.NextFunction) => {
+  if (res.headersSent) {
+    return next(err);
+  }
+
+  const originalError: APIError = {
+    code: err.name,
+    message: err.message,
+  };
+
+  res.status(500).json({
+    code: '500',
+    message: 'Oops! Something went wrong',
+    originalError: originalError,
+  } as APIError);
+});
+
+// Must be the last handler.
+app.use((req: express.Request, res: express.Response, _next: express.NextFunction) => {
+  const error: APIError = {
+    code: '404',
+    message: `Path ${req.path} not found.`,
+  };
+
+  res.status(404).json(error);
+});
+
+// eslint-disable-next-line
+const instance = app.listen(process.env.PORT || 9200, () =>
+  console.log(`Server started on port ${process.env.PORT || 9200}.`),
+);
+
+// Trap exit signals.
+['SIGTERM', 'SIGINT', 'SIGUSR2'].forEach(signalType => {
+  process.once(signalType, async () => {
+    // eslint-disable-next-line
+    console.log(`Received termination signal ${signalType}. Exiting.`);
+
+    try {
+      if (instance) {
+        instance.close();
+      }
+    } catch (e) {
+      // eslint-disable-next-line
+      console.error('Failed to gracefully exit', e);
+    }
+
+    process.exit();
+  });
+});

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/src/logger.ts

@@ -0,0 +1,55 @@
+enum LogLevel {
+  ERROR = 'error',
+  WARN = 'warn',
+  INFO = 'info',
+  LOG = 'log',
+  DEBUG = 'debug',
+}
+
+export class Logger {
+  private metadata: { [key: string]: string } = {};
+
+  private send(logLevel: LogLevel, message: string) {
+    console[logLevel](
+      // Datadog automatically parses JSON-formatted logs
+      JSON.stringify({
+        message: message,
+        ...this.metadata,
+      }),
+    );
+  }
+
+  public log(message: string) {
+    this.send(LogLevel.LOG, message);
+  }
+
+  public error(message: string) {
+    this.send(LogLevel.ERROR, message);
+  }
+
+  public warn(message: string) {
+    this.send(LogLevel.WARN, message);
+  }
+
+  public info(message: string) {
+    this.send(LogLevel.INFO, message);
+  }
+
+  public debug(message: string) {
+    this.send(LogLevel.DEBUG, message);
+  }
+
+  public decorate(metadata: { [key: string]: string }) {
+    this.metadata = metadata;
+  }
+
+  public setMeta(key: string, value: string) {
+    this.metadata[key] = value;
+  }
+
+  public clearMeta() {
+    this.metadata = {};
+  }
+}
+
+export const logger = new Logger();

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/src/middlewares/additionalLoggingContext.ts

@@ -0,0 +1,22 @@
+import express from 'express';
+import { logger } from '../logger';
+
+export const extractAdditionalLoggingContext = (req: express.Request, res: express.Response, next: express.NextFunction) => {
+  const additionalLoggingContextHeader = req.header('X-Unito-Additional-Logging-Context');
+
+  let additionalLoggingContext;
+
+  if (typeof additionalLoggingContextHeader === 'string') {
+    try {
+      additionalLoggingContext = JSON.parse(additionalLoggingContextHeader);
+    } catch (error) {
+      logger.warn(`Failed parsing header X-Unito-Additional-Logging-Context: ${additionalLoggingContext}`);
+    }
+  }
+
+  for (const [key, value] of Object.entries(additionalLoggingContext || {})) {
+    logger.setMeta(key, String(value));
+  }
+
+  next();
+};

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/src/middlewares/correlationId.ts

@@ -0,0 +1,13 @@
+import express from 'express';
+import * as uuid from 'uuid';
+import { logger } from '../logger';
+
+export const extractCorrelationId = (req: express.Request, res: express.Response, next: express.NextFunction) => {
+  const correlationIdHeader = req.header('X-Unito-Correlation-Id');
+
+  const correlationId = correlationIdHeader ?? uuid.v4();
+
+  logger.setMeta('correlation_id', correlationId);
+
+  next();
+};